62117 lines
5.0 MiB
Plaintext
62117 lines
5.0 MiB
Plaintext
[
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get API",
|
|
"api_call": "GET /apis/{apiId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Gets an API by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Update the API by the identifier",
|
|
"api_call": "PUT /apis/{apiId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Updates the API with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Delete an API.",
|
|
"api_call": "DELETE /apis/{apiId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Deletes the API with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Change the API compartment.",
|
|
"api_call": "POST /apis/{apiId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Changes the API compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get raw API content",
|
|
"api_call": "GET /apis/{apiId}/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"range": "string: The Range HTTP request header indicates the part of a document that the\nserver should return. [RFC 7233](https://tools.ietf.org/html/rfc7233#section-3.1).\nNote that only a single range of bytes is supported.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Get the raw API content.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get API Deployment specification based on the API.",
|
|
"api_call": "GET /apis/{apiId}/deploymentSpecification",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Gets an API Deployment specification by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get API content",
|
|
"api_call": "GET /apis/{apiId}/validations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Gets the API validation results.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis: Gets a list of all APIs in a compartment",
|
|
"api_call": "GET /apis",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of APIs.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis: Creates a new API",
|
|
"api_call": "POST /apis",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new API.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Get Certificate",
|
|
"api_call": "GET /certificates/{certificateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Gets a certificate by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Update Certificate by the identifier",
|
|
"api_call": "PUT /certificates/{certificateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Updates a certificate with the given identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Delete a provisioned Certificate",
|
|
"api_call": "DELETE /certificates/{certificateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Deletes the certificate with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Change the certificate compartment.",
|
|
"api_call": "POST /certificates/{certificateId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Changes the certificate compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates: Gets a list of all Certificates in a compartment",
|
|
"api_call": "GET /certificates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE` or `DELETED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of certificates.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates: Creates a new Certificate",
|
|
"api_call": "POST /certificates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new Certificate.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Get Deployment",
|
|
"api_call": "GET /deployments/{deploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Gets a deployment by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Update the Deployment identified by the id",
|
|
"api_call": "PUT /deployments/{deploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Updates the deployment with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Delete a provisioned Deployment",
|
|
"api_call": "DELETE /deployments/{deploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Deletes the deployment with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Change the deployment compartment.",
|
|
"api_call": "POST /deployments/{deploymentId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Changes the deployment compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments: Gets a list of all Deployments in a compartment",
|
|
"api_call": "GET /deployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `SUCCEEDED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of deployments.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments: Creates a new Deployment",
|
|
"api_call": "POST /deployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new deployment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Get Gateway",
|
|
"api_call": "GET /gateways/{gatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Gets a gateway by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Update the Gateway by the identifier",
|
|
"api_call": "PUT /gateways/{gatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Updates the gateway with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Delete a provisioned Gateway",
|
|
"api_call": "DELETE /gateways/{gatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Deletes the gateway with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Change the gateway compartment.",
|
|
"api_call": "POST /gateways/{gatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Changes the gateway compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways: Gets a list of all Gateways in a compartment",
|
|
"api_call": "GET /gateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `SUCCEEDED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of gateways.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways: Creates a new Gateway",
|
|
"api_call": "POST /gateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new gateway.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks > {sdk Id}: Downloadable link for the SDK.",
|
|
"api_call": "GET /sdks/{sdkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"sdkId": "[REQUIRED] string: (Required) The ocid of the SDK."
|
|
},
|
|
"functionality": "Return object store downloadable URL and metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks > {sdk Id}: Update the SDK by the identifier",
|
|
"api_call": "PUT /sdks/{sdkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"sdkId": "[REQUIRED] string: (Required) The ocid of the SDK."
|
|
},
|
|
"functionality": "Updates the SDK with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks > {sdk Id}: Deletes SDK",
|
|
"api_call": "DELETE /sdks/{sdkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"sdkId": "[REQUIRED] string: (Required) The ocid of the SDK."
|
|
},
|
|
"functionality": "Deletes provided SDK.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks: Lists SDKs",
|
|
"api_call": "GET /sdks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"sdkId": "string: The ocid of the SDK.",
|
|
"displayName": "string: A user-friendly name. Does not have to be unique, and it's changeable.\n\nExample: `My new resource`\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE` or `DELETED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n",
|
|
"apiId": "string: The ocid of the API."
|
|
},
|
|
"functionality": "Returns list of generated SDKs.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks: Creates an SDK",
|
|
"api_call": "POST /sdks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new SDK.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Gets work request status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Cancel the work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Cancels the work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Returns a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Returns a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests: List work requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"resourceId": "string: Filter work requests by the resource ocid.",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - General: Lists available SDK target languages.",
|
|
"api_call": "GET /sdkLanguageTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists programming languages in which SDK can be generated.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Delete a private reverse connection endpoint.",
|
|
"api_call": "DELETE /aiPrivateEndpoints/{aiPrivateEndpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Deletes a private reverse connection endpoint by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Get private reverse connection endpoint.",
|
|
"api_call": "GET /aiPrivateEndpoints/{aiPrivateEndpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Gets a specific private reverse connection by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Update the private reverse connection endpoint identified by the id.",
|
|
"api_call": "PUT /aiPrivateEndpoints/{aiPrivateEndpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Updates the private reverse connection endpoint.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.",
|
|
"api_call": "POST /aiPrivateEndpoints/{aiPrivateEndpointId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints: Lists all the AI private endpoints in the specified compartment",
|
|
"api_call": "GET /aiPrivateEndpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"displayName": "string: A filter to return only resources that match the entire display name given.",
|
|
"id": "string: unique AiPrivateEndpoint identifier",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
|
|
},
|
|
"functionality": "Returns a list of all the AI private endpoints in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints: Create a new private reverse connection endpoint.",
|
|
"api_call": "POST /aiPrivateEndpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new private reverse connection endpoint.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Delete a provisioned DataAsset",
|
|
"api_call": "DELETE /dataAssets/{dataAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Deletes a DataAsset resource by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Get DataAsset",
|
|
"api_call": "GET /dataAssets/{dataAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Gets a DataAsset by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Update the DataAsset identified by the id",
|
|
"api_call": "PUT /dataAssets/{dataAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Updates the DataAsset",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Change Data Asset Compartment",
|
|
"api_call": "POST /dataAssets/{dataAssetId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Changing the compartment of a data asset.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets: Gets a list of all DataAssets in a compartment",
|
|
"api_call": "GET /dataAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"projectId": "string: The ID of the project for which to list the objects.",
|
|
"displayName": "string: A filter to return only resources that match the entire display name given.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
|
|
},
|
|
"functionality": "Returns a list of DataAssets.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets: Creates a new DataAsset",
|
|
"api_call": "POST /dataAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new DataAsset.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Delete a provisioned Model",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Deletes an ai model resource by identifier. This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Get a Model",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Gets a Model by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Update the Model identified by the id",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Updates the Model",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Moves a Model resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models: Gets a list of all Models in a compartment",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"projectId": "string: The ID of the project for which to list the objects.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of Models.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models: Creates a new Model for training with the training data",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new Model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Delete a provisioned Project",
|
|
"api_call": "DELETE /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Deletes a Project resource by identifier. This operation fails with a 409 error unless all associated resources (models deployments or data assets) are in a DELETED state. You must delete all associated resources before deleting a project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Get Project",
|
|
"api_call": "GET /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Gets a Project by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Update the Project identified by the id",
|
|
"api_call": "PUT /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Updates the Project",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /projects/{projectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Moves a Project resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects: Gets a list of all Projects in a compartment.",
|
|
"api_call": "GET /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of Projects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects: Creates a new Project in the compartment.",
|
|
"api_call": "POST /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new Project.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: Cancel the work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancel work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: GET Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"workRequestId": "string: The ID of the asynchronous work request.",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - General: Detect Anomalies with an anomaly model and detection data",
|
|
"api_call": "POST /actions/detectAnomalies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Make a detect call with an anomaly model and detection data",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > configuration: GetContainerConfiguration",
|
|
"api_call": "GET /container/configuration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Get container configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > configuration: UpdateContainerConfiguration",
|
|
"api_call": "PUT /container/configuration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Update container configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures > {image Signature Id}: DeleteContainerImageSignature",
|
|
"api_call": "DELETE /container/imageSignatures/{imageSignatureId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageSignatureId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image signature.\n\nExample: `ocid1.containersignature.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Delete a container image signature.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures > {image Signature Id}: GetContainerImageSignature",
|
|
"api_call": "GET /container/imageSignatures/{imageSignatureId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageSignatureId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image signature.\n\nExample: `ocid1.containersignature.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Get container image signature metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures: ListContainerImageSignatures",
|
|
"api_call": "GET /container/imageSignatures",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentIdInSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"imageId": "string: A filter to return a container image summary only for the specified container image OCID.\n",
|
|
"repositoryId": "string: A filter to return container images only for the specified container repository OCID.\n",
|
|
"repositoryName": "string: A filter to return container images or container image signatures that match the repository name.\n\nExample: `foo` or `foo*`\n",
|
|
"imageDigest": "string: The digest of the container image.\n\nExample: `sha256:e7d38b3517548a1c71e41bffe9c8ae6d6d29546ce46bf62159837aad072c90aa`\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "List container image signatures in an image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures: CreateContainerImageSignature",
|
|
"api_call": "POST /container/imageSignatures",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Upload a signature to an image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id} > actions: RemoveContainerVersion",
|
|
"api_call": "POST /container/images/{imageId}/actions/removeVersion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Remove version from container image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id} > actions: RestoreContainerImage",
|
|
"api_call": "POST /container/images/{imageId}/actions/restore",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Restore a container image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id}: DeleteContainerImage",
|
|
"api_call": "DELETE /container/images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Delete a container image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id}: GetContainerImage",
|
|
"api_call": "GET /container/images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Get container image metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images: ListContainerImages",
|
|
"api_call": "GET /container/images",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentIdInSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "List container images in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: DeleteContainerRepository",
|
|
"api_call": "DELETE /container/repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Delete container repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: GetContainerRepository",
|
|
"api_call": "GET /container/repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Get container repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: UpdateContainerRepository",
|
|
"api_call": "PUT /container/repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Modify the properties of a container repository. Avoid entering confidential information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: ChangeContainerRepositoryCompartment",
|
|
"api_call": "POST /container/repositories/{repositoryId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Moves a container repository into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories: ListContainerRepositories",
|
|
"api_call": "GET /container/repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentIdInSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "List container repositories in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories: CreateContainerRepository",
|
|
"api_call": "POST /container/repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new empty container repository. Avoid entering confidential information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts > {artifact Id}: DeleteGenericArtifact",
|
|
"api_call": "DELETE /generic/artifacts/{artifactId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"artifactId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Deletes an artifact with a specified [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts > {artifact Id}: GetGenericArtifact",
|
|
"api_call": "GET /generic/artifacts/{artifactId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"artifactId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Gets information about an artifact with a specified [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts > {artifact Id}: UpdateGenericArtifact",
|
|
"api_call": "PUT /generic/artifacts/{artifactId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"artifactId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Updates the artifact with the specified [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can only update the tags of an artifact.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts: ListGenericArtifacts",
|
|
"api_call": "GET /generic/artifacts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"repositoryId": "string: (Required) A filter to return the artifacts only for the specified repository OCID.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists artifacts in the specified repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > repositories/{repository Id}/artifact Paths/{artifact Path}/versions/{version}: DeleteGenericArtifactByPath",
|
|
"api_call": "DELETE /generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n",
|
|
"artifactPath": "[REQUIRED] string: (Required) A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n",
|
|
"version": "[REQUIRED] string: (Required) A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n"
|
|
},
|
|
"functionality": "Deletes an artifact with a specified `artifactPath` and `version`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > repositories/{repository Id}/artifact Paths/{artifact Path}/versions/{version}: GetGenericArtifactByPath",
|
|
"api_call": "GET /generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n",
|
|
"artifactPath": "[REQUIRED] string: (Required) A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n",
|
|
"version": "[REQUIRED] string: (Required) A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n"
|
|
},
|
|
"functionality": "Gets information about an artifact with a specified `artifactPath` and `version`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > repositories/{repository Id}/artifact Paths/{artifact Path}/versions/{version}: UpdateGenericArtifactByPath",
|
|
"api_call": "PUT /generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n",
|
|
"artifactPath": "[REQUIRED] string: (Required) A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n",
|
|
"version": "[REQUIRED] string: (Required) A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n"
|
|
},
|
|
"functionality": "Updates an artifact with a specified `artifactPath` and `version`. You can only update the tags of an artifact.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: DeleteRepository",
|
|
"api_call": "DELETE /repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Deletes the specified repository. This operation fails unless all associated artifacts are in a DELETED state. You must delete all associated artifacts before deleting a repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: GetRepository",
|
|
"api_call": "GET /repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Gets the specified repository's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: UpdateRepository",
|
|
"api_call": "PUT /repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Updates the properties of a repository. You can update the `displayName` and `description` properties.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: ChangeRepositoryCompartment",
|
|
"api_call": "POST /repositories/{repositoryId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Moves a repository into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories: ListRepositories",
|
|
"api_call": "GET /repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists repositories in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories: CreateRepository",
|
|
"api_call": "POST /repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new repository for storing artifacts.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id} > actions: Initiates cluster migration to use native VCN.",
|
|
"api_call": "POST /clusters/{clusterId}/actions/migrateToNativeVcn",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Initiates cluster migration to use native VCN.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id} > actions: Update cluster endpoint details.",
|
|
"api_call": "POST /clusters/{clusterId}/actions/updateEndpointConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Update the details of the cluster endpoint configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Delete a cluster.",
|
|
"api_call": "DELETE /clusters/{clusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Delete a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Get cluster details.",
|
|
"api_call": "GET /clusters/{clusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Get the details of a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Update cluster details.",
|
|
"api_call": "PUT /clusters/{clusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Update the details of a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Create the cluster kubeconfig.",
|
|
"api_call": "POST /clusters/{clusterId}/kubeconfig/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Create the Kubeconfig YAML for a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Get details on a cluster's migration to native VCN.",
|
|
"api_call": "GET /clusters/{clusterId}/migrateToNativeVcnStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Get details on a cluster's migration to native VCN.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters: List all cluster objects.",
|
|
"api_call": "GET /clusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum. For important details about how pagination works,\nsee [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The optional order in which to sort the results.",
|
|
"sortBy": "string: The optional field to sort the results by."
|
|
},
|
|
"functionality": "List all the cluster objects in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters: Create a new cluster.",
|
|
"api_call": "POST /clusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token you supply to uniquely identify the request and provide idempotency if\nthe request is retried. Idempotency tokens expire after 24 hours.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools > {node Pool Id}: Delete a node pool.",
|
|
"api_call": "DELETE /nodePools/{nodePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"nodePoolId": "[REQUIRED] string: (Required) The OCID of the node pool."
|
|
},
|
|
"functionality": "Delete a node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools > {node Pool Id}: Get node pool details.",
|
|
"api_call": "GET /nodePools/{nodePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"nodePoolId": "[REQUIRED] string: (Required) The OCID of the node pool."
|
|
},
|
|
"functionality": "Get the details of a node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools > {node Pool Id}: Update node pool details.",
|
|
"api_call": "PUT /nodePools/{nodePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"nodePoolId": "[REQUIRED] string: (Required) The OCID of the node pool."
|
|
},
|
|
"functionality": "Update the details of a node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools: List all node pools.",
|
|
"api_call": "GET /nodePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"clusterId": "string: The OCID of the cluster.",
|
|
"name": "string: The name to filter on.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum. For important details about how pagination works,\nsee [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The optional order in which to sort the results.",
|
|
"sortBy": "string: The optional field to sort the results by."
|
|
},
|
|
"functionality": "List all the node pools in a compartment, and optionally filter by cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools: Create a new node pool.",
|
|
"api_call": "POST /nodePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token you supply to uniquely identify the request and provide idempotency if\nthe request is retried. Idempotency tokens expire after 24 hours.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Cancel a work request.",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Cancel a work request that has not started.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Get work request details.",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Get the details of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Get work request errors.",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Get the errors of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Get work request logs.",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Get the logs of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests: List all work requests.",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"clusterId": "string: The OCID of the cluster.",
|
|
"resourceId": "string: The OCID of the resource associated with a work request",
|
|
"resourceType": "string: Type of the resource associated with a work request",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum. For important details about how pagination works,\nsee [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The optional order in which to sort the results.",
|
|
"sortBy": "string: The optional field to sort the results by."
|
|
},
|
|
"functionality": "List all work requests in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - General: Get cluster options.",
|
|
"api_call": "GET /clusterOptions/{clusterOptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The OCID of the compartment.",
|
|
"clusterOptionId": "[REQUIRED] string: (Required) The id of the option set to retrieve. Use \"all\" get all options, or use a cluster ID to get options specific to the provided cluster."
|
|
},
|
|
"functionality": "Get options available for clusters.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - General: Get node pool options.",
|
|
"api_call": "GET /nodePoolOptions/{nodePoolOptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The OCID of the compartment.",
|
|
"nodePoolOptionId": "[REQUIRED] string: (Required) The id of the option set to retrieve. Use \"all\" get all options, or use a cluster ID to get options specific to the provided cluster."
|
|
},
|
|
"functionality": "Get options available for node pools.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id} > resource Versions > {resource Version}: GetAppCatalogListingResourceVersion",
|
|
"api_call": "GET /appCatalogListings/{listingId}/resourceVersions/{resourceVersion}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing.",
|
|
"resourceVersion": "[REQUIRED] string: (Required) Listing Resource Version."
|
|
},
|
|
"functionality": "Gets the specified listing resource version.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id} > resource Versions > {resource Version}: GetAppCatalogListingAgreements",
|
|
"api_call": "GET /appCatalogListings/{listingId}/resourceVersions/{resourceVersion}/agreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing.",
|
|
"resourceVersion": "[REQUIRED] string: (Required) Listing Resource Version."
|
|
},
|
|
"functionality": "Retrieves the agreements for a particular resource version of a listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id} > resource Versions: ListAppCatalogListingResourceVersions",
|
|
"api_call": "GET /appCatalogListings/{listingId}/resourceVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing."
|
|
},
|
|
"functionality": "Gets all resource versions for a particular listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id}: GetAppCatalogListing",
|
|
"api_call": "GET /appCatalogListings/{listingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing."
|
|
},
|
|
"functionality": "Gets the specified listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings: ListAppCatalogListings",
|
|
"api_call": "GET /appCatalogListings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"publisherName": "string: A filter to return only the publisher that matches the given publisher name exactly.\n",
|
|
"publisherType": "string: A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD.\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n"
|
|
},
|
|
"functionality": "Lists the published listings.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Subscriptions: DeleteAppCatalogSubscription",
|
|
"api_call": "DELETE /appCatalogSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "string: (Required) The OCID of the listing.",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"resourceVersion": "string: (Required) Listing Resource Version."
|
|
},
|
|
"functionality": "Delete a subscription for a listing resource version for a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Subscriptions: ListAppCatalogSubscriptions",
|
|
"api_call": "GET /appCatalogSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"listingId": "string: A filter to return only the listings that matches the given listing id.\n"
|
|
},
|
|
"functionality": "Lists subscriptions for a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Subscriptions: CreateAppCatalogSubscription",
|
|
"api_call": "POST /appCatalogSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - block Volume Replicas: ListBlockVolumeReplicas",
|
|
"api_call": "GET /blockVolumeReplicas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the block volume replicas in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - block Volume Replicas: GetBlockVolumeReplica",
|
|
"api_call": "GET /blockVolumeReplicas/{blockVolumeReplicaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"blockVolumeReplicaId": "[REQUIRED] string: (Required) The OCID of the block volume replica."
|
|
},
|
|
"functionality": "Gets information for the specified block volume replica.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments > {boot Volume Attachment Id}: DetachBootVolume",
|
|
"api_call": "DELETE /bootVolumeAttachments/{bootVolumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the boot volume attachment."
|
|
},
|
|
"functionality": "Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment.\n\nThis is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily\nuntil the attachment is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments > {boot Volume Attachment Id}: GetBootVolumeAttachment",
|
|
"api_call": "GET /bootVolumeAttachments/{bootVolumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the boot volume attachment."
|
|
},
|
|
"functionality": "Gets information about the specified boot volume attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments: ListBootVolumeAttachments",
|
|
"api_call": "GET /bootVolumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"bootVolumeId": "string: The OCID of the boot volume."
|
|
},
|
|
"functionality": "Lists the boot volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, boot volume OCID, or both.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments: AttachBootVolume",
|
|
"api_call": "POST /bootVolumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Attaches the specified boot volume to the specified instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id} > actions: ChangeBootVolumeBackupCompartment",
|
|
"api_call": "POST /bootVolumeBackups/{bootVolumeBackupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Moves a boot volume backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id} > actions: CreateBootVolumeBackupCopy",
|
|
"api_call": "POST /bootVolumeBackups/{bootVolumeBackupId}/actions/copy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Creates a boot volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id}: DeleteBootVolumeBackup",
|
|
"api_call": "DELETE /bootVolumeBackups/{bootVolumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Deletes a boot volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id}: GetBootVolumeBackup",
|
|
"api_call": "GET /bootVolumeBackups/{bootVolumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Gets information for the specified boot volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id}: UpdateBootVolumeBackup",
|
|
"api_call": "PUT /bootVolumeBackups/{bootVolumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Updates the display name for the specified boot volume backup.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups: ListBootVolumeBackups",
|
|
"api_call": "GET /bootVolumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"bootVolumeId": "string: The OCID of the boot volume.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sourceBootVolumeBackupId": "string: A filter to return only resources that originated from the given source boot volume backup.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is\ncase-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups: CreateBootVolumeBackup",
|
|
"api_call": "POST /bootVolumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Replicas: ListBootVolumeReplicas",
|
|
"api_call": "GET /bootVolumeReplicas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the boot volume replicas in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Replicas: GetBootVolumeReplica",
|
|
"api_call": "GET /bootVolumeReplicas/{bootVolumeReplicaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeReplicaId": "[REQUIRED] string: (Required) The OCID of the boot volume replica."
|
|
},
|
|
"functionality": "Gets information for the specified boot volume replica.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id} > kms Key: DeleteBootVolumeKmsKey",
|
|
"api_call": "DELETE /bootVolumes/{bootVolumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Removes the specified boot volume's assigned Key Management encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id} > kms Key: GetBootVolumeKmsKey",
|
|
"api_call": "GET /bootVolumes/{bootVolumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Gets the Key Management encryption key assigned to the specified boot volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id} > kms Key: UpdateBootVolumeKmsKey",
|
|
"api_call": "PUT /bootVolumes/{bootVolumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Updates the specified volume with a new Key Management master encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: DeleteBootVolume",
|
|
"api_call": "DELETE /bootVolumes/{bootVolumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Deletes the specified boot volume. The volume cannot have an active connection to an instance.\nTo disconnect the boot volume from a connected instance, see\n[Disconnecting From a Boot Volume](/iaas/Content/Block/Tasks/deletingbootvolume.htm).\n**Warning:** All data on the boot volume will be permanently lost when the boot volume is deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: GetBootVolume",
|
|
"api_call": "GET /bootVolumes/{bootVolumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Gets information for the specified boot volume.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: UpdateBootVolume",
|
|
"api_call": "PUT /bootVolumes/{bootVolumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Updates the specified boot volume's display name, defined tags, and free-form tags.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: ChangeBootVolumeCompartment",
|
|
"api_call": "POST /bootVolumes/{bootVolumeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Moves a boot volume into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes: ListBootVolumes",
|
|
"api_call": "GET /bootVolumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"volumeGroupId": "string: The OCID of the volume group."
|
|
},
|
|
"functionality": "Lists the boot volumes in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes: CreateBootVolume",
|
|
"api_call": "POST /bootVolumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup.\nFor general information about boot volumes, see [Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm).\nYou may optionally specify a *display name* for the volume, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: AdvertiseByoipRange",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/advertise",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud.\nThe `ByoipRange` resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: ChangeByoipRangeCompartment",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Moves a BYOIP CIDR block to a different compartment. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: ValidateByoipRange",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/validate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already\nmodified the information for the BYOIP CIDR block with your Regional Internet Registry. See [To import a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: WithdrawByoipRange",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/withdraw",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Withdraws BGP route advertisement for the BYOIP CIDR block.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: DeleteByoipRange",
|
|
"api_call": "DELETE /byoipRanges/{byoipRangeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Deletes the specified `ByoipRange` resource.\nThe resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED.\nIt must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail.\nYou must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nIf the `ByoipRange` resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: GetByoipRange",
|
|
"api_call": "GET /byoipRanges/{byoipRangeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Gets the `ByoipRange` resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: UpdateByoipRange",
|
|
"api_call": "PUT /byoipRanges/{byoipRangeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Updates the tags or display name associated to the specified BYOIP CIDR block.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: ListByoipAllocatedRanges",
|
|
"api_call": "GET /byoipRanges/{byoipRangeId}/byoipAllocatedRanges",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.\nEach `ByoipAllocatedRange` object also lists the IP pool where it is allocated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges: ListByoipRanges",
|
|
"api_call": "GET /byoipRanges",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Lists the `ByoipRange` resources in the specified compartment.\nYou can filter the list using query parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges: CreateByoipRange",
|
|
"api_call": "POST /byoipRanges",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a subrange of the BYOIP CIDR block.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: TerminateClusterNetwork",
|
|
"api_call": "DELETE /clusterNetworks/{clusterNetworkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Terminates the specified cluster network.\n\nWhen you delete a cluster network, all of its resources are permanently deleted,\nincluding associated instances and instance pools.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: GetClusterNetwork",
|
|
"api_call": "GET /clusterNetworks/{clusterNetworkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Gets information about the specified cluster network.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: UpdateClusterNetwork",
|
|
"api_call": "PUT /clusterNetworks/{clusterNetworkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Updates the specified cluster network. The OCID of the cluster network remains the same.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: ChangeClusterNetworkCompartment",
|
|
"api_call": "POST /clusterNetworks/{clusterNetworkId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Moves a cluster network into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move a cluster network to a different compartment, associated resources such as the instances\nin the cluster network, boot volumes, and VNICs are not moved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: ListClusterNetworkInstances",
|
|
"api_call": "GET /clusterNetworks/{clusterNetworkId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Lists the instances in the specified cluster network.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks: ListClusterNetworks",
|
|
"api_call": "GET /clusterNetworks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the cluster networks in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks: CreateClusterNetwork",
|
|
"api_call": "POST /clusterNetworks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a cluster network. For more information about cluster networks, see\n[Managing Cluster Networks](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: DeleteComputeCapacityReservation",
|
|
"api_call": "DELETE /computeCapacityReservations/{capacityReservationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Deletes the specified compute capacity reservation.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: GetComputeCapacityReservation",
|
|
"api_call": "GET /computeCapacityReservations/{capacityReservationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Gets information about the specified compute capacity reservation.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: UpdateComputeCapacityReservation",
|
|
"api_call": "PUT /computeCapacityReservations/{capacityReservationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Updates the specified capacity reservation and its associated capacity configurations.\nFields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted. \nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: ChangeComputeCapacityReservationCompartment",
|
|
"api_call": "POST /computeCapacityReservations/{capacityReservationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Moves a compute capacity reservation into a different compartment. For information about\nmoving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: ListComputeCapacityReservationInstances",
|
|
"api_call": "GET /computeCapacityReservations/{capacityReservationId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations: ListComputeCapacityReservations",
|
|
"api_call": "GET /computeCapacityReservations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the compute capacity reservations that match the specified criteria and compartment.\n\nYou can limit the list by specifying a compute capacity reservation display name\n(the list will include all the identically-named compute capacity reservations in the compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations: CreateComputeCapacityReservation",
|
|
"api_call": "POST /computeCapacityReservations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new compute capacity reservation in the specified compartment and availability domain.\nCompute capacity reservations let you reserve instances in a compartment.\nWhen you launch an instance using this reservation, you are assured that you have enough space for your instance,\nand you won't get out of capacity errors.\nFor more information, see [Reserved Capacity](/iaas/Content/Compute/Tasks/reserve-capacity.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas > {compute Global Image Capability Schema Id} > versions: ListComputeGlobalImageCapabilitySchemaVersions",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"computeGlobalImageCapabilitySchemaId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema"
|
|
},
|
|
"functionality": "Lists Compute Global Image Capability Schema versions in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas > {compute Global Image Capability Schema Id} > versions: GetComputeGlobalImageCapabilitySchemaVersion",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions/{computeGlobalImageCapabilitySchemaVersionName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"computeGlobalImageCapabilitySchemaId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema",
|
|
"computeGlobalImageCapabilitySchemaVersionName": "[REQUIRED] string: (Required) The name of the compute global image capability schema version"
|
|
},
|
|
"functionality": "Gets the specified Compute Global Image Capability Schema Version",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas > {compute Global Image Capability Schema Id}: GetComputeGlobalImageCapabilitySchema",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"computeGlobalImageCapabilitySchemaId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema"
|
|
},
|
|
"functionality": "Gets the specified Compute Global Image Capability Schema",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas: ListComputeGlobalImageCapabilitySchemas",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that match the given compartment OCID exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists Compute Global Image Capability Schema in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: DeleteComputeImageCapabilitySchema",
|
|
"api_call": "DELETE /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Deletes the specified Compute Image Capability Schema\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: GetComputeImageCapabilitySchema",
|
|
"api_call": "GET /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"isMergeEnabled": "boolean: Merge the image capability schema with the global image capability schema\n",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Gets the specified Compute Image Capability Schema\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: UpdateComputeImageCapabilitySchema",
|
|
"api_call": "PUT /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Updates the specified Compute Image Capability Schema\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: ChangeComputeImageCapabilitySchemaCompartment",
|
|
"api_call": "POST /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Moves a compute image capability schema into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas: ListComputeImageCapabilitySchemas",
|
|
"api_call": "GET /computeImageCapabilitySchemas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that match the given compartment OCID exactly.\n",
|
|
"imageId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an image.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas: CreateComputeImageCapabilitySchema",
|
|
"api_call": "POST /computeImageCapabilitySchemas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates compute image capability schema.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpe Device Shapes: ListCpeDeviceShapes",
|
|
"api_call": "GET /cpeDeviceShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the CPE device types that the Networking service provides CPE configuration\ncontent for (example: Cisco ASA). The content helps a network engineer configure\nthe actual CPE device represented by a [Cpe](#/en/iaas/latest/Cpe/) object.\n\nIf you want to generate CPE configuration content for one of the returned CPE device types,\nensure that the [Cpe](#/en/iaas/latest/Cpe/) object's `cpeDeviceShapeId` attribute is set\nto the CPE device type's [OCID](/Content/General/Concepts/identifiers.htm) (returned by this operation).\n\nFor information about generating CPE configuration content, see these operations:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpe Device Shapes: GetCpeDeviceShape",
|
|
"api_call": "GET /cpeDeviceShapes/{cpeDeviceShapeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeDeviceShapeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape."
|
|
},
|
|
"functionality": "Gets the detailed information about the specified CPE device type. This might include a set of questions\nthat are specific to the particular CPE device type. The customer must supply answers to those questions\n(see [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)).\nThe service merges the answers with a template of other information for the CPE device type. The following\noperations return the merged content:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: DeleteCpe",
|
|
"api_call": "DELETE /cpes/{cpeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous\noperation. The CPE's `lifecycleState` will change to TERMINATING temporarily until the CPE is completely\nremoved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: GetCpe",
|
|
"api_call": "GET /cpes/{cpeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Gets the specified CPE's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: UpdateCpe",
|
|
"api_call": "PUT /cpes/{cpeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Updates the specified CPE's display name or tags.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: ChangeCpeCompartment",
|
|
"api_call": "POST /cpes/{cpeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Moves a CPE object into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: GetCpeDeviceConfigContent",
|
|
"api_call": "GET /cpes/{cpeId}/cpeConfigContent",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Renders a set of CPE configuration content that can help a network engineer configure the actual\nCPE device (for example, a hardware router) represented by the specified [Cpe](#/en/iaas/latest/Cpe/)\nobject.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) must have the CPE's device type specified by the `cpeDeviceShapeId`\nattribute. The content optionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for *all* of the\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/) objects that use the specified CPE.\nHere are similar operations:\n\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n returns CPE configuration content for all IPSec tunnels in a single IPSec connection.\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n returns CPE configuration content for a specific IPSec tunnel in an IPSec connection.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes: ListCpes",
|
|
"api_call": "GET /cpes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the customer-premises equipment objects (CPEs) in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes: CreateCpe",
|
|
"api_call": "POST /cpes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For\nmore information, see [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec\nconnection or other Networking Service components. If you're not sure which compartment to\nuse, put the CPE in the same compartment as the DRG. For more information about\ncompartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must provide the public IP address of your on-premises router. See\n[CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm).\n\nYou may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to\nbe unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: DeleteCrossConnectGroup",
|
|
"api_call": "DELETE /crossConnectGroups/{crossConnectGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Deletes the specified cross-connect group. It must not contain any\ncross-connects, and it cannot be mapped to a\n[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: GetCrossConnectGroups",
|
|
"api_call": "GET /crossConnectGroups/{crossConnectGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Gets the specified cross-connect group's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: UpdateCrossConnectGroup",
|
|
"api_call": "PUT /crossConnectGroups/{crossConnectGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Updates the specified cross-connect group's display name.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: ChangeCrossConnectGroupCompartment",
|
|
"api_call": "POST /crossConnectGroups/{crossConnectGroupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Moves a cross-connect group into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups: ListCrossConnectGroups",
|
|
"api_call": "GET /crossConnectGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the cross-connect groups in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups: CreateCrossConnectGroup",
|
|
"api_call": "POST /crossConnectGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new cross-connect group to use with Oracle Cloud Infrastructure\nFastConnect. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the cross-connect group to reside. If you're\nnot sure which compartment to use, put the cross-connect group in the\nsame compartment with your VCN. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the cross-connect group.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: DeleteCrossConnect",
|
|
"api_call": "DELETE /crossConnects/{crossConnectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Deletes the specified cross-connect. It must not be mapped to a\n[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: GetCrossConnect",
|
|
"api_call": "GET /crossConnects/{crossConnectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Gets the specified cross-connect's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: UpdateCrossConnect",
|
|
"api_call": "PUT /crossConnects/{crossConnectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Updates the specified cross-connect.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: ChangeCrossConnectCompartment",
|
|
"api_call": "POST /crossConnects/{crossConnectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Moves a cross-connect into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: GetCrossConnectLetterOfAuthority",
|
|
"api_call": "GET /crossConnects/{crossConnectId}/letterOfAuthority",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Gets the Letter of Authority for the specified cross-connect.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: GetCrossConnectStatus",
|
|
"api_call": "GET /crossConnects/{crossConnectId}/status",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Gets the status of the specified cross-connect.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects: ListCrossConnects",
|
|
"api_call": "GET /crossConnects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"crossConnectGroupId": "string: The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the cross-connects in the specified compartment. You can filter the list\nby specifying the [OCID](/Content/General/Concepts/identifiers.htm) of a cross-connect group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects: CreateCrossConnect",
|
|
"api_call": "POST /crossConnects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new cross-connect. Oracle recommends you create each cross-connect in a\n[CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation\nwith the connection.\n\nAfter creating the `CrossConnect` object, you need to go the FastConnect location\nand request to have the physical cable installed. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the cross-connect to reside. If you're\nnot sure which compartment to use, put the cross-connect in the\nsame compartment with your VCN. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the cross-connect.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: DeleteDedicatedVmHost",
|
|
"api_call": "DELETE /dedicatedVmHosts/{dedicatedVmHostId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Deletes the specified dedicated virtual machine host.\n\nIf any VM instances are assigned to the dedicated virtual machine host,\nthe delete operation will fail and the service will return a 409 response code.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: GetDedicatedVmHost",
|
|
"api_call": "GET /dedicatedVmHosts/{dedicatedVmHostId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Gets information about the specified dedicated virtual machine host.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: UpdateDedicatedVmHost",
|
|
"api_call": "PUT /dedicatedVmHosts/{dedicatedVmHostId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.\nIf an attribute value is not included, it will not be updated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: ChangeDedicatedVmHostCompartment",
|
|
"api_call": "POST /dedicatedVmHosts/{dedicatedVmHostId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Moves a dedicated virtual machine host from one compartment to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: ListDedicatedVmHostInstances",
|
|
"api_call": "GET /dedicatedVmHosts/{dedicatedVmHostId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts: ListDedicatedVmHosts",
|
|
"api_call": "GET /dedicatedVmHosts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"instanceShapeName": "string: The name for the instance's shape.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"remainingMemoryInGBsGreaterThanOrEqualTo": "number: The remaining memory of the dedicated VM host, in GBs.",
|
|
"remainingOcpusGreaterThanOrEqualTo": "number: The available OCPUs of the dedicated VM host."
|
|
},
|
|
"functionality": "Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.\n\nYou can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named\ndedicated virtual machine hosts in the compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts: CreateDedicatedVmHost",
|
|
"api_call": "POST /dedicatedVmHosts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.\nDedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers\nthat are a single tenant and not shared with other customers.\nFor more information, see [Dedicated Virtual Machine Hosts](/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: DeleteDhcpOptions",
|
|
"api_call": "DELETE /dhcps/{dhcpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a\nVCN's default set of DHCP options.\n\nThis is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily\nuntil the set is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: GetDhcpOptions",
|
|
"api_call": "GET /dhcps/{dhcpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Gets the specified set of DHCP options.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: UpdateDhcpOptions",
|
|
"api_call": "PUT /dhcps/{dhcpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Updates the specified set of DHCP options. You can update the display name or the options\nthemselves. Avoid entering confidential information.\n\nNote that the `options` object you provide replaces the entire existing set of options.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: ChangeDhcpOptionsCompartment",
|
|
"api_call": "POST /dhcps/{dhcpId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Moves a set of DHCP options into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps: ListDhcpOptions",
|
|
"api_call": "GET /dhcps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"vcnId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the sets of DHCP options in the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment.\nThe response includes the default set of options that automatically comes with each VCN,\nplus any other sets you've created.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps: CreateDhcpOptions",
|
|
"api_call": "POST /dhcps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new set of DHCP options for the specified VCN. For more information, see\n[DhcpOptions](#/en/iaas/latest/DhcpOptions/).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the set of\nDHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN,\nsubnets, or other Networking Service components. If you're not sure which compartment to use, put the set\nof DHCP options in the same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the set of DHCP options, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: DeleteDrgAttachment",
|
|
"api_call": "DELETE /drgAttachments/{drgAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Detaches a DRG from a network resource by deleting the corresponding `DrgAttachment` resource. This is an asynchronous\noperation. The attachment's `lifecycleState` will temporarily change to DETACHING until the attachment\nis completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: GetDrgAttachment",
|
|
"api_call": "GET /drgAttachments/{drgAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Gets the `DrgAttachment` resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: UpdateDrgAttachment",
|
|
"api_call": "PUT /drgAttachments/{drgAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Updates the display name and routing information for the specified `DrgAttachment`.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: RemoveExportDrgRouteDistribution",
|
|
"api_call": "POST /drgAttachments/{drgAttachmentId}/actions/removeExportDrgRouteDistribution",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Removes the export route distribution from the DRG attachment so no routes are advertised to it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments: ListDrgAttachments",
|
|
"api_call": "GET /drgAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"vcnId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.",
|
|
"drgId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"networkId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG.",
|
|
"attachmentType": "string: The type for the network resource attached to the DRG.",
|
|
"drgRouteTableId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to the DRG attachment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the `DrgAttachment` resource for the specified compartment. You can filter the\nresults by DRG, attached network, attachment type, DRG route table or\nVCN route table.\n\nThe LIST API lists DRG attachments by attachment type. It will default to list VCN attachments,\nbut you may request to list ALL attachments of ALL types. \n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments: CreateDrgAttachment",
|
|
"api_call": "POST /drgAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG\nat a time, but a DRG can be attached to more than one VCN. The response includes a `DrgAttachment`\nobject with its own [OCID](/Content/General/Concepts/identifiers.htm). For more information about DRGs, see\n[Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm).\n\nYou may optionally specify a *display name* for the attachment, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor the purposes of access control, the DRG attachment is automatically placed into the currently selected compartment.\nFor more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id} > actions: AddDrgRouteDistributionStatements",
|
|
"api_call": "POST /drgRouteDistributions/{drgRouteDistributionId}/actions/addDrgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Adds one or more route distribution statements to the specified route distribution.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id} > actions: RemoveDrgRouteDistributionStatements",
|
|
"api_call": "POST /drgRouteDistributions/{drgRouteDistributionId}/actions/removeDrgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Removes one or more route distribution statements from the specified route distribution's map.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id} > actions: UpdateDrgRouteDistributionStatements",
|
|
"api_call": "POST /drgRouteDistributions/{drgRouteDistributionId}/actions/updateDrgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Updates one or more route distribution statements in the specified route distribution.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: DeleteDrgRouteDistribution",
|
|
"api_call": "DELETE /drgRouteDistributions/{drgRouteDistributionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table.\n\nRemove the DRG route distribution from a DRG attachment or DRG route table by using the \"RemoveExportDrgRouteDistribution\" or \"RemoveImportDrgRouteDistribution' operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: GetDrgRouteDistribution",
|
|
"api_call": "GET /drgRouteDistributions/{drgRouteDistributionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Gets the specified route distribution's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: UpdateDrgRouteDistribution",
|
|
"api_call": "PUT /drgRouteDistributions/{drgRouteDistributionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Updates the specified route distribution\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: ListDrgRouteDistributionStatements",
|
|
"api_call": "GET /drgRouteDistributions/{drgRouteDistributionId}/drgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by.",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Lists the statements for the specified route distribution.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions: ListDrgRouteDistributionStatements",
|
|
"api_call": "GET /drgRouteDistributions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter that only returns resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the route distributions in the specified DRG.\n\nTo retrieve the statements in a distribution, use the\nListDrgRouteDistributionStatements operation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions: CreateDrgRouteDistribution",
|
|
"api_call": "POST /drgRouteDistributions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new route distribution for the specified DRG. \nAssign the route distribution as an import distribution to a DRG route table using the `UpdateDrgRouteTable` or `CreateDrgRouteTable` operations.\nAssign the route distribution as an export distribution to a DRG attachment\nusing the `UpdateDrgAttachment` or `CreateDrgAttachment` operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: AddDrgRouteRules",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/addDrgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Adds one or more static route rules to the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: RemoveDrgRouteRules",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/removeDrgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Removes one or more route rules from the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: RemoveImportDrgRouteDistribution",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/removeImportDrgRouteDistribution",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Removes the import route distribution from the DRG route table so no routes are imported\ninto it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: UpdateDrgRouteRules",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/updateDrgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Updates one or more route rules in the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: DeleteDrgRouteTable",
|
|
"api_call": "DELETE /drgRouteTables/{drgRouteTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Deletes the specified DRG route table. There must not be any DRG attachments assigned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: GetDrgRouteTable",
|
|
"api_call": "GET /drgRouteTables/{drgRouteTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Gets the specified DRG route table's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: UpdateDrgRouteTable",
|
|
"api_call": "PUT /drgRouteTables/{drgRouteTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Updates the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: ListDrgRouteRules",
|
|
"api_call": "GET /drgRouteTables/{drgRouteTableId}/drgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"routeType": "string: Static routes are specified through the DRG route table API.\nDynamic routes are learned by the DRG from the DRG attachments through various routing protocols.\n",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Lists the route rules in the specified DRG route table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables: ListDrgRouteTables",
|
|
"api_call": "GET /drgRouteTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"importDrgRouteDistributionId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution.\n",
|
|
"lifecycleState": "string: A filter that only returns matches for the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the DRG route tables for the specified DRG.\n\nUse the `ListDrgRouteRules` operation to retrieve the route rules in a table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables: CreateDrgRouteTable",
|
|
"api_call": "POST /drgRouteTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment\nusing the `UpdateDrgAttachment` or `CreateDrgAttachment` operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id} > actions: GetAllDrgAttachments",
|
|
"api_call": "POST /drgs/{drgId}/actions/getAllDrgAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"attachmentType": "string: The type for the network resource attached to the DRG.",
|
|
"isCrossTenancy": "boolean: Whether the DRG attachment lives in a different tenancy than the DRG.",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Returns a complete list of DRG attachments that belong to a particular DRG.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id} > actions: UpgradeDrg",
|
|
"api_call": "POST /drgs/{drgId}/actions/upgrade",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Upgrades the DRG. After upgrade, you can control routing inside your DRG\nvia DRG attachments, route distributions, and DRG route tables.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id} > actions: UpgradeStatus",
|
|
"api_call": "GET /drgs/{drgId}/actions/upgradeStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: DeleteDrg",
|
|
"api_call": "DELETE /drgs/{drgId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise\nnetwork. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous\noperation. The DRG's `lifecycleState` will change to TERMINATING temporarily until the DRG is completely\nremoved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: GetDrg",
|
|
"api_call": "GET /drgs/{drgId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Gets the specified DRG's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: UpdateDrg",
|
|
"api_call": "PUT /drgs/{drgId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Updates the specified DRG's display name or tags. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: GetDrgRedundancyStatus",
|
|
"api_call": "GET /drgs/{drgId}/redundancyStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Gets the redundancy status for the specified DRG. For more information, see\n[Redundancy Remedies](/iaas/Content/Network/Troubleshoot/drgredundancy.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs: ListDrgs",
|
|
"api_call": "GET /drgs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the DRGs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs: CreateDrg",
|
|
"api_call": "POST /drgs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information,\nsee [Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN,\nthe DRG attachment, or other Networking Service components. If you're not sure which compartment\nto use, put the DRG in the same compartment as the VCN. For more information about compartments\nand access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the DRG, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services > {provider Service Id}: GetFastConnectProviderService",
|
|
"api_call": "GET /fastConnectProviderServices/{providerServiceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"providerServiceId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service."
|
|
},
|
|
"functionality": "Gets the specified provider service.\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services > {provider Service Id}: GetFastConnectProviderServiceKey",
|
|
"api_call": "GET /fastConnectProviderServices/{providerServiceId}/providerServiceKeys/{providerServiceKeyName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"providerServiceId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service.",
|
|
"providerServiceKeyName": "[REQUIRED] string: (Required) The provider service key that the provider gives you when you set up a virtual circuit connection\nfrom the provider to Oracle Cloud Infrastructure. You can set up that connection and get your\nprovider service key at the provider's website or portal. For the portal location, see the `description`\nattribute of the [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/).\n"
|
|
},
|
|
"functionality": "Gets the specified provider service key's information. Use this operation to validate a\nprovider service key. An invalid key returns a 404 error.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services > {provider Service Id}: ListFastConnectProviderVirtualCircuitBandwidthShapes",
|
|
"api_call": "GET /fastConnectProviderServices/{providerServiceId}/virtualCircuitBandwidthShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"providerServiceId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service."
|
|
},
|
|
"functionality": "Gets the list of available virtual circuit bandwidth levels for a provider.\nYou need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit.\n\nFor more information about virtual circuits, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services: ListFastConnectProviderServices",
|
|
"api_call": "GET /fastConnectProviderServices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the service offerings from supported providers. You need this\ninformation so you can specify your desired provider and service\noffering when you create a virtual circuit.\n\nFor the compartment ID, provide the [OCID](/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).\n\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > actions: ChangeImageCompartment",
|
|
"api_call": "POST /images/{imageId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Moves an image into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > actions: ExportImage",
|
|
"api_call": "POST /images/{imageId}/actions/export",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL,\nor the namespace, bucket name, and object name when specifying the location to export to.\n\nFor more information about exporting images, see [Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm).\n\nTo perform an image export, you need write access to the Object Storage bucket for the image,\nsee [Let Users Write Objects to Object Storage Buckets](/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4).\n\nSee [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm)\nfor constructing URLs for image import/export.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes > {shape Name}: RemoveImageShapeCompatibilityEntry",
|
|
"api_call": "DELETE /images/{imageId}/shapes/{shapeName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.",
|
|
"shapeName": "[REQUIRED] string: (Required) Shape name."
|
|
},
|
|
"functionality": "Removes a shape from the compatible shapes list for the image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes > {shape Name}: GetImageShapeCompatibilityEntry",
|
|
"api_call": "GET /images/{imageId}/shapes/{shapeName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.",
|
|
"shapeName": "[REQUIRED] string: (Required) Shape name."
|
|
},
|
|
"functionality": "Retrieves an image shape compatibility entry.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes > {shape Name}: AddImageShapeCompatibilityEntry",
|
|
"api_call": "PUT /images/{imageId}/shapes/{shapeName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.",
|
|
"shapeName": "[REQUIRED] string: (Required) Shape name."
|
|
},
|
|
"functionality": "Adds a shape to the compatible shapes list for the image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes: ListImageShapeCompatibilityEntries",
|
|
"api_call": "GET /images/{imageId}/shapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Lists the compatible shapes for the specified image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id}: DeleteImage",
|
|
"api_call": "DELETE /images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Deletes an image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id}: GetImage",
|
|
"api_call": "GET /images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Gets the specified image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id}: UpdateImage",
|
|
"api_call": "PUT /images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Updates the display name of the image. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images: ListImages",
|
|
"api_call": "GET /images",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists a subset of images available in the specified compartment, including\n[platform images](/iaas/Content/Compute/References/images.htm) and\n[custom images](/iaas/Content/Compute/Tasks/managingcustomimages.htm). \nThe list of platform images includes the three most recently published versions \nof each major distribution.\n\nThe list of images returned is ordered to first show the recent platform images,\nthen all of the custom images.\n\n**Caution:** Platform images are refreshed regularly. When new images are released, older versions are replaced. \nThe image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images: CreateImage",
|
|
"api_call": "POST /images",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.\n\nWhen creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and\nthe OCID of the compartment containing that instance. For more information about images,\nsee [Managing Custom Images](/iaas/Content/Compute/Tasks/managingcustomimages.htm).\n\nWhen importing an exported image from Object Storage, you specify the source information\nin [ImageSourceDetails](#/en/iaas/latest/requests/ImageSourceDetails).\n\nWhen importing an image based on the namespace, bucket name, and object name,\nuse [ImageSourceViaObjectStorageTupleDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageTupleDetails).\n\nWhen importing an image based on the Object Storage URL, use\n[ImageSourceViaObjectStorageUriDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageUriDetails).\nSee [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm)\nfor constructing URLs for image import/export.\n\nFor more information about importing exported images, see\n[Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm).\n\nYou may optionally specify a *display name* for the image, which is simply a friendly name or description.\nIt does not have to be unique, and you can change it. See [UpdateImage](#/en/iaas/latest/Image/UpdateImage).\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id} > actions: ChangeInstanceConfigurationCompartment",
|
|
"api_call": "POST /instanceConfigurations/{instanceConfigurationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Moves an instance configuration into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance configuration to a different compartment, associated resources such as\ninstance pools are not moved.\n\n**Important:** Most of the properties for an existing instance configuration, including the compartment,\ncannot be modified after you create the instance configuration. Although you can move an instance configuration\nto a different compartment, you will not be able to use the instance configuration to manage instance pools\nin the new compartment. If you want to update an instance configuration to point to a different compartment,\nyou should instead create a new instance configuration in the target compartment using\n[CreateInstanceConfiguration](/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id} > actions: LaunchInstanceConfiguration",
|
|
"api_call": "POST /instanceConfigurations/{instanceConfigurationId}/actions/launch",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Launches an instance from an instance configuration.\n\nIf the instance configuration does not include all of the parameters that are\nrequired to launch an instance, such as the availability domain and subnet ID, you must\nprovide these parameters when you launch an instance from the instance configuration.\nFor more information, see the [InstanceConfiguration](#/en/iaas/latest/InstanceConfiguration/)\nresource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id}: DeleteInstanceConfiguration",
|
|
"api_call": "DELETE /instanceConfigurations/{instanceConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Deletes an instance configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id}: GetInstanceConfiguration",
|
|
"api_call": "GET /instanceConfigurations/{instanceConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Gets the specified instance configuration",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id}: UpdateInstanceConfiguration",
|
|
"api_call": "PUT /instanceConfigurations/{instanceConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Updates the free-form tags, defined tags, and display name of an instance configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations: ListInstanceConfigurations",
|
|
"api_call": "GET /instanceConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the instance configurations in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations: CreateInstanceConfiguration",
|
|
"api_call": "POST /instanceConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates an instance configuration. An instance configuration is a template that defines the\nsettings to use when creating Compute instances.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections > {instance Console Connection Id}: DeleteInstanceConsoleConnection",
|
|
"api_call": "DELETE /instanceConsoleConnections/{instanceConsoleConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleConnectionId": "[REQUIRED] string: (Required) The OCID of the instance console connection."
|
|
},
|
|
"functionality": "Deletes the specified instance console connection.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections > {instance Console Connection Id}: GetInstanceConsoleConnection",
|
|
"api_call": "GET /instanceConsoleConnections/{instanceConsoleConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleConnectionId": "[REQUIRED] string: (Required) The OCID of the instance console connection."
|
|
},
|
|
"functionality": "Gets the specified instance console connection's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections > {instance Console Connection Id}: UpdateInstanceConsoleConnection",
|
|
"api_call": "PUT /instanceConsoleConnections/{instanceConsoleConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConsoleConnectionId": "[REQUIRED] string: (Required) The OCID of the instance console connection."
|
|
},
|
|
"functionality": "Updates the defined tags and free-form tags for the specified instance console connection.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections: ListInstanceConsoleConnections",
|
|
"api_call": "GET /instanceConsoleConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the console connections for the specified compartment or instance.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections: CreateInstanceConsoleConnection",
|
|
"api_call": "POST /instanceConsoleConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new console connection to the specified instance.\nAfter the console connection has been created and is available,\nyou connect to the console using SSH.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: DeleteConsoleHistory",
|
|
"api_call": "DELETE /instanceConsoleHistories/{instanceConsoleHistoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Deletes the specified console history metadata and the console history data.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: GetConsoleHistory",
|
|
"api_call": "GET /instanceConsoleHistories/{instanceConsoleHistoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Shows the metadata for the specified console history.\nSee [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)\nfor details about using the console history operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: UpdateConsoleHistory",
|
|
"api_call": "PUT /instanceConsoleHistories/{instanceConsoleHistoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Updates the specified console history metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: GetConsoleHistoryContent",
|
|
"api_call": "GET /instanceConsoleHistories/{instanceConsoleHistoryId}/data",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"offset": "integer: Offset of the snapshot data to retrieve.",
|
|
"length": "integer: Length of the snapshot data to retrieve.",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Gets the actual console history data (not the metadata).\nSee [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)\nfor details about using the console history operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories: ListConsoleHistories",
|
|
"api_call": "GET /instanceConsoleHistories/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the console history metadata for the specified compartment or instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories: CaptureConsoleHistory",
|
|
"api_call": "POST /instanceConsoleHistories/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Captures the most recent serial console data (up to a megabyte) for the\nspecified instance.\n\nThe `CaptureConsoleHistory` operation works with the other console history operations\nas described below.\n\n1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the\nmost recent console history. This call returns a `ConsoleHistory`\nobject. The object will have a state of REQUESTED.\n2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with\nthe identifier of the console history metadata. The state of the\n`ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and\nthen SUCCEEDED (or FAILED).\n3. Use `GetConsoleHistoryContent` to get the actual console history data (not the\nmetadata).\n4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata\nand the console history data.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: AttachLoadBalancer",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/attachLoadBalancer",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Attach a load balancer to the instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: ChangeInstancePoolCompartment",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Moves an instance pool into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance pool to a different compartment, associated resources such as the instances in\nthe pool, boot volumes, VNICs, and autoscaling configurations are not moved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: DetachInstancePoolInstance",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/detachInstance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Detaches an instance from an instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: DetachLoadBalancer",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/detachLoadBalancer",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Detach a load balancer from the instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: ResetInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/reset",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the reset (immediate power off and power on) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: SoftresetInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/softreset",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the softreset (ACPI shutdown and power on) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n\nSoftreset gracefully reboots the instances by sending a shutdown command to the operating systems.\nAfter waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: StartInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the start (power on) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: StopInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the stop (immediate power off) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > instances: ListInstancePoolInstances",
|
|
"api_call": "GET /instancePools/{instancePoolId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "List the instances in the specified instance pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > instances: AttachInstancePoolInstance",
|
|
"api_call": "POST /instancePools/{instancePoolId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Attaches an instance to an instance pool. For information about the prerequisites\nthat an instance must meet before you can attach it to a pool, see\n[Attaching an Instance to an Instance Pool](/iaas/Content/Compute/Tasks/updatinginstancepool.htm#attach-instance).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > instances: GetInstancePoolInstance",
|
|
"api_call": "GET /instancePools/{instancePoolId}/instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets information about an instance that belongs to an instance pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: TerminateInstancePool",
|
|
"api_call": "DELETE /instancePools/{instancePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Terminate the specified instance pool.\n\n**Warning:** When you delete an instance pool, the resources that were created by the pool are permanently\ndeleted, including associated instances, attached boot volumes, and block volumes.\n\nIf an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted\nasynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using\nthe `DeleteAutoScalingConfiguration` operation in the Autoscaling API.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: GetInstancePool",
|
|
"api_call": "GET /instancePools/{instancePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Gets the specified instance pool",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: UpdateInstancePool",
|
|
"api_call": "PUT /instancePools/{instancePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Update the specified instance pool.\n\nThe OCID of the instance pool remains the same.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: GetLoadBalancerAttachment",
|
|
"api_call": "GET /instancePools/{instancePoolId}/loadBalancerAttachments/{instancePoolLoadBalancerAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.",
|
|
"instancePoolLoadBalancerAttachmentId": "[REQUIRED] string: (Required) The OCID of the load balancer attachment."
|
|
},
|
|
"functionality": "Gets information about a load balancer that is attached to the specified instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools: ListInstancePools",
|
|
"api_call": "GET /instancePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the instance pools in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools: CreateInstancePool",
|
|
"api_call": "POST /instancePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create an instance pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id} > actions: AcceptShieldedIntegrityPolicy",
|
|
"api_call": "POST /instances/{instanceId}/actions/acceptShieldedIntegrityPolicy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Accept the changes to the PCR values in the measured boot report.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id} > actions: ChangeInstanceCompartment",
|
|
"api_call": "POST /instances/{instanceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Moves an instance into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance to a different compartment, associated resources such as boot volumes and VNICs\nare not moved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: TerminateInstance",
|
|
"api_call": "DELETE /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"preserveBootVolume": "boolean: Specifies whether to delete or preserve the boot volume when terminating an instance.\nWhen set to `true`, the boot volume is preserved. The default value is `false`.\n",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Terminates the specified instance. Any attached VNICs and volumes are automatically detached\nwhen the instance terminates.\n\nTo preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`.\nTo delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`.\n\nThis is an asynchronous operation. The instance's `lifecycleState` will change to TERMINATING temporarily\nuntil the instance is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetInstance",
|
|
"api_call": "GET /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets information about the specified instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: InstanceAction",
|
|
"api_call": "POST /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"Content-Type": "string",
|
|
"action": "string: (Required) The action to perform on the instance.",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Performs one of the following power actions on the specified instance:\n\n- **START** - Powers on the instance.\n\n- **STOP** - Powers off the instance.\n\n- **RESET** - Powers off the instance and then powers it back on.\n\n- **SOFTSTOP** - Gracefully shuts down the instance by sending a shutdown command to the operating system.\nAfter waiting 15 minutes for the OS to shut down, the instance is powered off.\nIf the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting\nin data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the\ninstance.\n\n- **SOFTRESET** - Gracefully reboots the instance by sending a shutdown command to the operating system.\nAfter waiting 15 minutes for the OS to shut down, the instance is powered off and\nthen powered back on.\n\n- **SENDDIAGNOSTICINTERRUPT** - For advanced users. **Warning: Sending a diagnostic interrupt to a live system can\ncause data corruption or system failure.** Sends a diagnostic interrupt that causes the instance's\nOS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a\ncrash dump file when it crashes. The crash dump captures information about the state of the OS at the time of\nthe crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see\n[Sending a Diagnostic Interrupt](/iaas/Content/Compute/Tasks/sendingdiagnosticinterrupt.htm).\n\n\nFor more information about managing instance lifecycle states, see\n[Stopping and Starting an Instance](/iaas/Content/Compute/Tasks/restartinginstance.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: UpdateInstance",
|
|
"api_call": "PUT /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Updates certain fields on the specified instance. Fields that are not provided in the\nrequest will not be updated. Avoid entering confidential information.\n\nChanges to metadata fields will be reflected in the instance metadata service (this may take\nup to a minute).\n\nThe OCID of the instance remains the same.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetInstanceDefaultCredentials",
|
|
"api_call": "GET /instances/{instanceId}/defaultCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.\nFor certain operating systems, users will be forced to change the initial credentials.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: ListInstanceDevices",
|
|
"api_call": "GET /instances/{instanceId}/devices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"isAvailable": "boolean: A filter to return only available devices or only used devices.\n",
|
|
"name": "string: A filter to return only devices that match the given name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets a list of all the devices for given instance. You can optionally filter results by device availability.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetWindowsInstanceInitialCredentials",
|
|
"api_call": "GET /instances/{instanceId}/initialCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Deprecated. Use [GetInstanceDefaultCredentials](#/en/iaas/latest/InstanceCredentials/GetInstanceDefaultCredentials) instead.\n\nGets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.\nFor certain operating systems, users will be forced to change the initial credentials.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetMeasuredBootReport",
|
|
"api_call": "GET /instances/{instanceId}/measuredBootReport",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets the measured boot report for this shielded instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances: ListInstances",
|
|
"api_call": "GET /instances/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the instances in the specified compartment and the specified availability domain.\nYou can filter the results by specifying an instance name (the list will include all the identically-named\ninstances in the compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances: LaunchInstance",
|
|
"api_call": "POST /instances/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new instance in the specified compartment and the specified availability domain.\nFor general information about instances, see\n[Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm).\n\nFor information about access control and compartments, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nFor information about availability domains, see\n[Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).\nTo get a list of availability domains, use the `ListAvailabilityDomains` operation\nin the Identity and Access Management Service API.\n\nAll Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned,\nunique ID called an Oracle Cloud Identifier (OCID).\nWhen you create a resource, you can find its OCID in the response. You can\nalso retrieve a resource's OCID by using a List API operation\non that resource type, or by viewing the resource in the Console.\n\nTo launch an instance using an image or a boot volume use the `sourceDetails` parameter in [LaunchInstanceDetails](#/en/iaas/latest/LaunchInstanceDetails).\n\nWhen you launch an instance, it is automatically attached to a virtual\nnetwork interface card (VNIC), called the *primary VNIC*. The VNIC\nhas a private IP address from the subnet's CIDR. You can either assign a\nprivate IP address of your choice or let Oracle automatically assign one.\nYou can choose whether the instance has a public IP address. To retrieve the\naddresses, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation to get the VNIC ID for the instance, and then call\n[GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID.\n\nYou can later add secondary VNICs to an instance. For more information, see\n[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).\n\nTo launch an instance from a Marketplace image listing, you must provide the image ID of the\nlisting resource version that you want, but you also must subscribe to the listing before you try\nto launch the instance. To subscribe to the listing, use the [GetAppCatalogListingAgreements](#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements)\noperation to get the signature for the terms of use agreement for the desired listing resource version.\nThen, call [CreateAppCatalogSubscription](#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription)\nwith the signature. To get the image ID for the LaunchInstance operation, call\n[GetAppCatalogListingResourceVersion](#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: DeleteInternetGateway",
|
|
"api_call": "DELETE /internetGateways/{igId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Deletes the specified internet gateway. The internet gateway does not have to be disabled, but\nthere must not be a route table that lists it as a target.\n\nThis is an asynchronous operation. The gateway's `lifecycleState` will change to TERMINATING temporarily\nuntil the gateway is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: GetInternetGateway",
|
|
"api_call": "GET /internetGateways/{igId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Gets the specified internet gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: UpdateInternetGateway",
|
|
"api_call": "PUT /internetGateways/{igId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Updates the specified internet gateway. You can disable/enable it, or change its display name\nor tags. Avoid entering confidential information.\n\nIf the gateway is disabled, that means no traffic will flow to/from the internet even if there's\na route rule that enables that traffic.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: ChangeInternetGatewayCompartment",
|
|
"api_call": "POST /internetGateways/{igId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Moves an internet gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways: ListInternetGateways",
|
|
"api_call": "GET /internetGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the internet gateways in the specified VCN and the specified compartment.\nIf the VCN ID is not provided, then the list includes the internet gateways from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways: CreateInternetGateway",
|
|
"api_call": "POST /internetGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new internet gateway for the specified VCN. For more information, see\n[Access to the Internet](/iaas/Content/Network/Tasks/managingIGs.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the Internet\nGateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or\nother Networking Service components. If you're not sure which compartment to use, put the Internet\nGateway in the same compartment with the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nYou may optionally specify a *display name* for the internet gateway, otherwise a default is provided. It\ndoes not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in\nthe subnet's route table (for example, 0.0.0.0/0 > internet gateway). See\n[UpdateRouteTable](#/en/iaas/latest/RouteTable/UpdateRouteTable).\n\nYou must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no\ntraffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later\nuse [UpdateInternetGateway](#/en/iaas/latest/InternetGateway/UpdateInternetGateway) to easily disable/enable\nthe gateway without changing the route rule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > shared Secret: GetIPSecConnectionTunnelSharedSecret",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Gets the specified tunnel's shared secret (pre-shared key). To get other information\nabout the tunnel, use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > shared Secret: UpdateIPSecConnectionTunnelSharedSecret",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Updates the shared secret (pre-shared key) for the specified tunnel.\n\n**Important:** If you change the shared secret, the tunnel will go down while it's reprovisioned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > tunnel Device Config: GetTunnelCpeDeviceConfig",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Gets the set of CPE configuration answers for the tunnel, which the customer provided in\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig).\nTo get the full set of content for the tunnel (any answers merged with the template of other\ninformation specific to the CPE device type), use\n[GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > tunnel Device Config: UpdateTunnelCpeDeviceConfig",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Creates or updates the set of CPE configuration answers for the specified tunnel.\nThe answers correlate to the questions that are specific to the CPE device type (see the\n`parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > tunnel Device Config: GetTunnelCpeDeviceConfigContent",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a\nnetwork engineer configure the actual CPE device (for example, a hardware router) that the specified\nIPSec tunnel terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content\noptionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for only the specified IPSec tunnel.\nHere are other similar operations:\n\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n returns CPE configuration content for all tunnels in a single IPSec connection.\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n returns CPE configuration content for *all* IPSec connections that use a specific CPE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id}: GetIPSecConnectionTunnel",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Gets the specified tunnel's information. The resulting object does not include the tunnel's\nshared secret (pre-shared key). To retrieve that, use\n[GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id}: UpdateIPSecConnectionTunnelDetails",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}/tunnels/{tunnelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Updates the specified tunnel. This operation lets you change tunnel attributes such as the\nrouting type (BGP dynamic routing or static routing). Here are some important notes:\n\n * If you change the tunnel's routing type or BGP session configuration, the tunnel will go\n down while it's reprovisioned.\n\n * If you want to switch the tunnel's `routing` from `STATIC` to `BGP`, make sure the tunnel's\n BGP session configuration attributes have been set ([bgpSessionConfig](#/en/iaas/latest/datatypes/BgpSessionInfo)).\n\n * If you want to switch the tunnel's `routing` from `BGP` to `STATIC`, make sure the\n [IPSecConnection](#/en/iaas/latest/IPSecConnection/) already has at least one valid CIDR\n static route.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels: ListIPSecConnectionTunnels",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Lists the tunnel information for the specified IPSec connection.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: DeleteIPSecConnection",
|
|
"api_call": "DELETE /ipsecConnections/{ipscId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and\non-premises network, it's easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact.\nIf you were to delete all the components and then later need to create an Site-to-Site VPN again, you would\nneed to configure your on-premises router again with the new information returned from\n[CreateIPSecConnection](#/en/iaas/latest/IPSecConnection/CreateIPSecConnection).\n\nThis is an asynchronous operation. The connection's `lifecycleState` will change to TERMINATING temporarily\nuntil the connection is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIPSecConnection",
|
|
"api_call": "GET /ipsecConnections/{ipscId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Gets the specified IPSec connection's basic information, including the static routes for the\non-premises router. If you want the status of the connection (whether it's up or down), use\n[GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: UpdateIPSecConnection",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Updates the specified IPSec connection.\n\nTo update an individual IPSec tunnel's attributes, use\n[UpdateIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/UpdateIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: ChangeIPSecConnectionCompartment",
|
|
"api_call": "POST /ipsecConnections/{ipscId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Moves an IPSec connection into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIpsecCpeDeviceConfigContent",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/cpeConfigContent",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Renders a set of CPE configuration content for the specified IPSec connection (for all the\ntunnels in the connection). The content helps a network engineer configure the actual CPE\ndevice (for example, a hardware router) that the specified IPSec connection terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content\noptionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for all tunnels in the single specified\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/) object. Here are other similar\noperations:\n\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n returns CPE configuration content for a specific tunnel within an IPSec connection.\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n returns CPE configuration content for *all* IPSec connections that use a specific CPE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIPSecConnectionDeviceConfig",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/deviceConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Deprecated. To get tunnel information, instead use:\n\n* [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel)\n* [GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIPSecConnectionDeviceStatus",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/deviceStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Deprecated. To get the tunnel status, instead use\n[GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections: ListIPSecConnections",
|
|
"api_call": "GET /ipsecConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the IPSec connections for the specified compartment. You can filter the\nresults by DRG or CPE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections: CreateIPSecConnection",
|
|
"api_call": "POST /ipsecConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new IPSec connection between the specified DRG and CPE. For more information, see\n[Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nIf you configure at least one tunnel to use static routing, then in the request you must provide\nat least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16.\nIf you configure both tunnels to use BGP dynamic routing, you can provide an empty list for\nthe static routes. For more information, see the important note in\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the\nIPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment\nas the DRG, CPE, or other Networking Service components. If you're not sure which compartment to\nuse, put the IPSec connection in the same compartment as the DRG. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nYou may optionally specify a *display name* for the IPSec connection, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nAfter creating the IPSec connection, you need to configure your on-premises router\nwith tunnel-specific information. For tunnel status and the required configuration information, see:\n\n * [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)\n * [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/)\n\nFor each tunnel, you need the IP address of Oracle's VPN headend and the shared secret\n(that is, the pre-shared key). For more information, see\n[CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6 > {ipv6Id}: DeleteIpv6",
|
|
"api_call": "DELETE /ipv6/{ipv6Id}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipv6Id": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6."
|
|
},
|
|
"functionality": "Unassigns and deletes the specified IPv6. You must specify the object's [OCID](/Content/General/Concepts/identifiers.htm).\nThe IPv6 address is returned to the subnet's pool of available addresses.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6 > {ipv6Id}: GetIpv6",
|
|
"api_call": "GET /ipv6/{ipv6Id}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipv6Id": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6."
|
|
},
|
|
"functionality": "Gets the specified IPv6. You must specify the object's [OCID](/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListIpv6s](#/en/iaas/latest/Ipv6/ListIpv6s)\nwith the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6 > {ipv6Id}: UpdateIpv6",
|
|
"api_call": "PUT /ipv6/{ipv6Id}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipv6Id": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6."
|
|
},
|
|
"functionality": "Updates the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n * Move an IPv6 to a different VNIC in the same subnet.\n * Enable/disable internet access for an IPv6.\n * Change the display name for an IPv6.\n * Update resource tags for an IPv6.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6: ListIpv6s",
|
|
"api_call": "GET /ipv6",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"ipAddress": "string: An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n",
|
|
"subnetId": "string: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet.",
|
|
"vnicId": "string: The OCID of the VNIC."
|
|
},
|
|
"functionality": "Lists the [IPv6](#/en/iaas/latest/Ipv6/) objects based\non one of these filters:\n\n * Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * Both IPv6 address and subnet OCID: This lets you get an `Ipv6` object based on its private\n IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetIpv6](#/en/iaas/latest/Ipv6/GetIpv6) requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6: CreateIpv6",
|
|
"api_call": "POST /ipv6",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates an IPv6 for the specified VNIC.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id} > actions: ChangeLocalPeeringGatewayCompartment",
|
|
"api_call": "POST /localPeeringGateways/{localPeeringGatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Moves a local peering gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id} > actions: ConnectLocalPeeringGateways",
|
|
"api_call": "POST /localPeeringGateways/{localPeeringGatewayId}/actions/connect",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Connects this local peering gateway (LPG) to another one in the same region.\n\nThis operation must be called by the VCN administrator who is designated as\nthe *requestor* in the peering relationship. The *acceptor* must implement\nan Identity and Access Management (IAM) policy that gives the requestor permission\nto connect to LPGs in the acceptor's compartment. Without that permission, this\noperation will fail. For more information, see\n[VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id}: DeleteLocalPeeringGateway",
|
|
"api_call": "DELETE /localPeeringGateways/{localPeeringGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Deletes the specified local peering gateway (LPG).\n\nThis is an asynchronous operation; the local peering gateway's `lifecycleState` changes to TERMINATING temporarily\nuntil the local peering gateway is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id}: GetLocalPeeringGateway",
|
|
"api_call": "GET /localPeeringGateways/{localPeeringGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Gets the specified local peering gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id}: UpdateLocalPeeringGateway",
|
|
"api_call": "PUT /localPeeringGateways/{localPeeringGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Updates the specified local peering gateway (LPG).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways: ListLocalPeeringGateways",
|
|
"api_call": "GET /localPeeringGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"vcnId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Lists the local peering gateways (LPGs) for the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways: CreateLocalPeeringGateway",
|
|
"api_call": "POST /localPeeringGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new local peering gateway (LPG) for the specified VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: DeleteNatGateway",
|
|
"api_call": "DELETE /natGateways/{natGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there\nmust not be a route rule that lists the NAT gateway as a target.\n\nThis is an asynchronous operation. The NAT gateway's `lifecycleState` will change to\nTERMINATING temporarily until the NAT gateway is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: GetNatGateway",
|
|
"api_call": "GET /natGateways/{natGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Gets the specified NAT gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: UpdateNatGateway",
|
|
"api_call": "PUT /natGateways/{natGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Updates the specified NAT gateway.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: ChangeNatGatewayCompartment",
|
|
"api_call": "POST /natGateways/{natGatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Moves a NAT gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways: ListNatGateways",
|
|
"api_call": "GET /natGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID\nto filter the results by VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways: CreateNatGateway",
|
|
"api_call": "POST /natGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the\nNAT gateway as the rule's target. See [Route Table](#/en/iaas/latest/RouteTable/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: AddNetworkSecurityGroupSecurityRules",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/addSecurityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Adds one or more security rules to the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: ChangeNetworkSecurityGroupCompartment",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Moves a network security group into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: RemoveNetworkSecurityGroupSecurityRules",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/removeSecurityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Removes one or more security rules from the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: UpdateNetworkSecurityGroupSecurityRules",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/updateSecurityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Updates one or more security rules in the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: DeleteNetworkSecurityGroup",
|
|
"api_call": "DELETE /networkSecurityGroups/{networkSecurityGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Deletes the specified network security group. The group must not contain any VNICs.\n\nTo get a list of the VNICs in a network security group, use\n[ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics).\nEach returned [NetworkSecurityGroupVnic](#/en/iaas/latest/NetworkSecurityGroupVnic/) object\ncontains both the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC and the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC's parent resource (for example,\nthe Compute instance that the VNIC is attached to).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: GetNetworkSecurityGroup",
|
|
"api_call": "GET /networkSecurityGroups/{networkSecurityGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Gets the specified network security group's information.\n\nTo list the VNICs in an NSG, see\n[ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics).\n\nTo list the security rules in an NSG, see\n[ListNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/ListNetworkSecurityGroupSecurityRules).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: UpdateNetworkSecurityGroup",
|
|
"api_call": "PUT /networkSecurityGroups/{networkSecurityGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Updates the specified network security group.\n\nTo add or remove an existing VNIC from the group, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n\nTo add a VNIC to the group *when you create the VNIC*, specify the NSG's [OCID](/iaas/Content/General/Concepts/identifiers.htm) during creation.\nFor example, see the `nsgIds` attribute in [CreateVnicDetails](#/en/iaas/latest/datatypes/CreateVnicDetails).\n\nTo add or remove security rules from the group, use\n[AddNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/AddNetworkSecurityGroupSecurityRules)\nor\n[RemoveNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/RemoveNetworkSecurityGroupSecurityRules).\n\nTo edit the contents of existing security rules in the group, use\n[UpdateNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/UpdateNetworkSecurityGroupSecurityRules).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: ListNetworkSecurityGroupSecurityRules",
|
|
"api_call": "GET /networkSecurityGroups/{networkSecurityGroupId}/securityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"direction": "string: Direction of the security rule. Set to `EGRESS` for rules that allow outbound IP packets,\nor `INGRESS` for rules that allow inbound IP packets.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by.",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Lists the security rules in the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: ListNetworkSecurityGroupVnics",
|
|
"api_call": "GET /networkSecurityGroups/{networkSecurityGroupId}/vnics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by.",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Lists the VNICs in the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups: ListNetworkSecurityGroups",
|
|
"api_call": "GET /networkSecurityGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists either the network security groups in the specified compartment, or those associated with the specified VLAN.\nYou must specify either a `vlanId` or a `compartmentId`, but not both. If you specify a `vlanId`, all other parameters are ignored.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups: CreateNetworkSecurityGroup",
|
|
"api_call": "POST /networkSecurityGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new network security group for the specified VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips > {private Ip Id}: DeletePrivateIp",
|
|
"api_call": "DELETE /privateIps/{privateIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"privateIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
|
|
},
|
|
"functionality": "Unassigns and deletes the specified private IP. You must\nspecify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The private IP address is returned to\nthe subnet's pool of available addresses.\n\nThis operation cannot be used with primary private IPs, which are\nautomatically unassigned and deleted when the VNIC is terminated.\n\n**Important:** If a secondary private IP is the\n[target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),\nunassigning it from the VNIC causes that route rule to blackhole and the traffic\nwill be dropped.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips > {private Ip Id}: GetPrivateIp",
|
|
"api_call": "GET /privateIps/{privateIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"privateIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
|
|
},
|
|
"functionality": "Gets the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps)\nwith the private IP address (for example, 10.0.3.3) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips > {private Ip Id}: UpdatePrivateIp",
|
|
"api_call": "PUT /privateIps/{privateIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"privateIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
|
|
},
|
|
"functionality": "Updates the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n - Move a secondary private IP to a different VNIC in the same subnet.\n - Change the display name for a secondary private IP.\n - Change the hostname for a secondary private IP.\n\nThis operation cannot be used with primary private IPs.\nTo update the hostname for the primary IP on a VNIC, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips: ListPrivateIps",
|
|
"api_call": "GET /privateIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"ipAddress": "string: An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n",
|
|
"subnetId": "string: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet.",
|
|
"vnicId": "string: The OCID of the VNIC.",
|
|
"vlanId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Lists the [PrivateIp](#/en/iaas/latest/PrivateIp/) objects based\non one of these filters:\n\n - Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - Both private IP address and subnet OCID: This lets\n you get a `privateIP` object based on its private IP\n address (for example, 10.0.3.3) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp)\n requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nIf you're listing all the private IPs associated with a given subnet\nor VNIC, the response includes both primary and secondary private IPs.\n\nIf you are an Oracle Cloud VMware Solution customer and have VLANs\nin your VCN, you can filter the list by VLAN [OCID](/iaas/Content/General/Concepts/identifiers.htm). See [Vlan](#/en/iaas/latest/Vlan).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips: CreatePrivateIp",
|
|
"api_call": "POST /privateIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a secondary private IP for the specified VNIC.\nFor more information about secondary private IPs, see\n[IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id} > actions: AddPublicIpPoolCapacity",
|
|
"api_call": "POST /publicIpPools/{publicIpPoolId}/actions/addCapacity",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Adds some or all of a CIDR block to a public IP pool.\n\nThe CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id} > actions: ChangePublicIpPoolCompartment",
|
|
"api_call": "POST /publicIpPools/{publicIpPoolId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Moves a public IP pool to a different compartment. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id} > actions: RemovePublicIpPoolCapacity",
|
|
"api_call": "POST /publicIpPools/{publicIpPoolId}/actions/removeCapacity",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Removes a CIDR block from the referenced public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id}: DeletePublicIpPool",
|
|
"api_call": "DELETE /publicIpPools/{publicIpPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Deletes the specified public IP pool.\nTo delete a public IP pool it must not have any active IP address allocations.\nYou must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm) when deleting an IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id}: GetPublicIpPool",
|
|
"api_call": "GET /publicIpPools/{publicIpPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Gets the specified `PublicIpPool` object. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id}: UpdatePublicIpPool",
|
|
"api_call": "PUT /publicIpPools/{publicIpPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Updates the specified public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools: ListPublicIpPools",
|
|
"api_call": "GET /publicIpPools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Lists the public IP pools in the specified compartment.\nYou can filter the list using query parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools: CreatePublicIpPool",
|
|
"api_call": "POST /publicIpPools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > actions: GetPublicIpByIpAddress",
|
|
"api_call": "POST /publicIps/actions/getByIpAddress",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Gets the public IP based on the public IP address (for example, 203.0.113.2).\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, the service returns the public IP object with\n`lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > actions: GetPublicIpByPrivateIpId",
|
|
"api_call": "POST /publicIps/actions/getByPrivateIpId",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Gets the public IP assigned to the specified private IP. You must specify the OCID\nof the private IP. If no public IP is assigned, a 404 is returned.\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, and you provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the original private\nIP, this operation returns a 404. If you instead provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target\nprivate IP, or if you instead call\n[GetPublicIp](#/en/iaas/latest/PublicIp/GetPublicIp) or\n[GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress), the\nservice returns the public IP object with `lifecycleState` = ASSIGNING and\n`assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: DeletePublicIp",
|
|
"api_call": "DELETE /publicIps/{publicIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Unassigns and deletes the specified public IP (either ephemeral or reserved).\nYou must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The public IP address is returned to the\nOracle Cloud Infrastructure public IP pool.\n\n**Note:** You cannot update, unassign, or delete the public IP that Oracle automatically\nassigned to an entity for you (such as a load balancer or NAT gateway). The public IP is\nautomatically deleted if the assigned entity is terminated.\n\nFor an assigned reserved public IP, the initial unassignment portion of this operation\nis asynchronous. Poll the public IP's `lifecycleState` to determine\nif the operation succeeded.\n\nIf you want to simply unassign a reserved public IP and return it to your pool\nof reserved public IPs, instead use\n[UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: GetPublicIp",
|
|
"api_call": "GET /publicIps/{publicIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Gets the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nAlternatively, you can get the object by using [GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress)\nwith the public IP address (for example, 203.0.113.2).\n\nOr you can use [GetPublicIpByPrivateIpId](#/en/iaas/latest/PublicIp/GetPublicIpByPrivateIpId)\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is assigned to.\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, the service returns the public IP object with\n`lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: UpdatePublicIp",
|
|
"api_call": "PUT /publicIps/{publicIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Updates the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). Use this operation if you want to:\n\n* Assign a reserved public IP in your pool to a private IP.\n* Move a reserved public IP to a different private IP.\n* Unassign a reserved public IP from a private IP (which returns it to your pool\nof reserved public IPs).\n* Change the display name or tags for a public IP.\n\nAssigning, moving, and unassigning a reserved public IP are asynchronous\noperations. Poll the public IP's `lifecycleState` to determine if the operation\nsucceeded.\n\n**Note:** When moving a reserved public IP, the target private IP\nmust not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it\ndoes, an error is returned. Also, the initial unassignment from the original\nprivate IP always succeeds, but the assignment to the target private IP is asynchronous and\ncould fail silently (for example, if the target private IP is deleted or has a different public IP\nassigned to it in the interim). If that occurs, the public IP remains unassigned and its\n`lifecycleState` switches to AVAILABLE (it is not reassigned to its original private IP).\nYou must poll the public IP's `lifecycleState` to determine if the move succeeded.\n\nRegarding ephemeral public IPs:\n\n* If you want to assign an ephemeral public IP to a primary private IP, use\n[CreatePublicIp](#/en/iaas/latest/PublicIp/CreatePublicIp).\n* You can't move an ephemeral public IP to a different private IP.\n* If you want to unassign an ephemeral public IP from its private IP, use\n[DeletePublicIp](#/en/iaas/latest/PublicIp/DeletePublicIp), which\nunassigns and deletes the ephemeral public IP.\n\n**Note:** If a public IP is assigned to a secondary private\nIP (see [PrivateIp](#/en/iaas/latest/PrivateIp)), and you move that secondary\nprivate IP to another VNIC, the public IP moves with it.\n\n**Note:** There's a limit to the number of [public IPs](#/en/iaas/latest/PublicIp/)\na VNIC or instance can have. If you try to move a reserved public IP\nto a VNIC or instance that has already reached its public IP limit, an error is\nreturned. For information about the public IP limits, see\n[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: ChangePublicIpCompartment",
|
|
"api_call": "POST /publicIps/{publicIpId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Moves a public IP into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nThis operation applies only to reserved public IPs. Ephemeral public IPs always belong to the\nsame compartment as their VNIC and move accordingly.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips: ListPublicIps",
|
|
"api_call": "GET /publicIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"scope": "string: (Required) Whether the public IP is regional or specific to a particular availability domain.\n\n* `REGION`: The public IP exists within a region and is assigned to a regional entity\n(such as a [NatGateway](#/en/iaas/latest/NatGateway/)), or can be assigned to a private IP\nin any availability domain in the region. Reserved public IPs have `scope` = `REGION`, as do\nephemeral public IPs assigned to a regional entity.\n\n* `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity\nit's assigned to, which is specified by the `availabilityDomain` property of the public IP object.\nEphemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.\n",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"lifetime": "string: A filter to return only public IPs that match given lifetime.\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Lists the [PublicIp](#/en/iaas/latest/PublicIp/) objects\nin the specified compartment. You can filter the list by using query parameters.\n\nTo list your reserved public IPs:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `RESERVED`\n\nTo list the ephemeral public IPs assigned to a regional entity such as a NAT gateway:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `EPHEMERAL`\n\nTo list the ephemeral public IPs assigned to private IPs:\n * Set `scope` = `AVAILABILITY_DOMAIN` (required)\n * Set the `availabilityDomain` parameter to the desired availability domain (required)\n * Set `lifetime` = `EPHEMERAL`\n\n**Note:** An ephemeral public IP assigned to a private IP\nis always in the same availability domain and compartment as the private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips: CreatePublicIp",
|
|
"api_call": "POST /publicIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a public IP. Use the `lifetime` property to specify whether it's an ephemeral or\nreserved public IP. For information about limits on how many you can create, see\n[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n\n* **For an ephemeral public IP assigned to a private IP:** You must also specify a `privateIpId`\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary private IP you want to assign the public IP to. The public IP is\ncreated in the same availability domain as the private IP. An ephemeral public IP must always be\nassigned to a private IP, and only to the *primary* private IP on a VNIC, not a secondary\nprivate IP. Exception: If you create a [NatGateway](#/en/iaas/latest/NatGateway/), Oracle\nautomatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove.\n\n* **For a reserved public IP:** You may also optionally assign the public IP to a private\nIP by specifying `privateIpId`. Or you can later assign the public IP with\n[UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp).\n\n**Note:** When assigning a public IP to a private IP, the private IP must not already have\na public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned.\n\nAlso, for reserved public IPs, the optional assignment part of this operation is\nasynchronous. Poll the public IP's `lifecycleState` to determine if the assignment\nsucceeded.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id} > actions: ChangeRemotePeeringConnectionCompartment",
|
|
"api_call": "POST /remotePeeringConnections/{remotePeeringConnectionId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id} > actions: ConnectRemotePeeringConnections",
|
|
"api_call": "POST /remotePeeringConnections/{remotePeeringConnectionId}/actions/connect",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Connects this RPC to another one in a different region.\n\nThis operation must be called by the VCN administrator who is designated as\nthe *requestor* in the peering relationship. The *acceptor* must implement\nan Identity and Access Management (IAM) policy that gives the requestor permission\nto connect to RPCs in the acceptor's compartment. Without that permission, this\noperation will fail. For more information, see\n[VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id}: DeleteRemotePeeringConnection",
|
|
"api_call": "DELETE /remotePeeringConnections/{remotePeeringConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Deletes the remote peering connection (RPC).\n\nThis is an asynchronous operation; the RPC's `lifecycleState` changes to TERMINATING temporarily\nuntil the RPC is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id}: GetRemotePeeringConnection",
|
|
"api_call": "GET /remotePeeringConnections/{remotePeeringConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Get the specified remote peering connection's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id}: UpdateRemotePeeringConnection",
|
|
"api_call": "PUT /remotePeeringConnections/{remotePeeringConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Updates the specified remote peering connection (RPC).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections: ListRemotePeeringConnections",
|
|
"api_call": "GET /remotePeeringConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the remote peering connections (RPCs) for the specified DRG and compartment\n(the RPC's compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections: CreateRemotePeeringConnection",
|
|
"api_call": "POST /remotePeeringConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new remote peering connection (RPC) for the specified DRG.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: DeleteRouteTable",
|
|
"api_call": "DELETE /routeTables/{rtId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a\nVCN's default route table.\n\nThis is an asynchronous operation. The route table's `lifecycleState` will change to TERMINATING temporarily\nuntil the route table is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: GetRouteTable",
|
|
"api_call": "GET /routeTables/{rtId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Gets the specified route table's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: UpdateRouteTable",
|
|
"api_call": "PUT /routeTables/{rtId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Updates the specified route table's display name or route rules.\nAvoid entering confidential information.\n\nNote that the `routeRules` object you provide replaces the entire existing set of rules.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: ChangeRouteTableCompartment",
|
|
"api_call": "POST /routeTables/{rtId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Moves a route table into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables: ListRouteTables",
|
|
"api_call": "GET /routeTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the route tables in the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment.\nThe response includes the default route table that automatically comes with\neach VCN in the specified compartment, plus any route tables you've created.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables: CreateRouteTable",
|
|
"api_call": "POST /routeTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new route table for the specified VCN. In the request you must also include at least one route\nrule for the new route table. For information on the number of rules you can have in a route table, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For general information about route\ntables in your VCN and the types of targets you can use in route rules,\nsee [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the route\ntable to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets,\nor other Networking Service components. If you're not sure which compartment to use, put the route\ntable in the same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the route table, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: DeleteSecurityList",
|
|
"api_call": "DELETE /securityLists/{securityListId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Deletes the specified security list, but only if it's not associated with a subnet. You can't delete\na VCN's default security list.\n\nThis is an asynchronous operation. The security list's `lifecycleState` will change to TERMINATING temporarily\nuntil the security list is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: GetSecurityList",
|
|
"api_call": "GET /securityLists/{securityListId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Gets the specified security list's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: UpdateSecurityList",
|
|
"api_call": "PUT /securityLists/{securityListId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Updates the specified security list's display name or rules.\nAvoid entering confidential information.\n\nNote that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire\nexisting objects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: ChangeSecurityListCompartment",
|
|
"api_call": "POST /securityLists/{securityListId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Moves a security list into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists: ListSecurityLists",
|
|
"api_call": "GET /securityLists",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the security lists in the specified VCN and compartment.\nIf the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists: CreateSecurityList",
|
|
"api_call": "POST /securityLists",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new security list for the specified VCN. For more information\nabout security lists, see [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm).\nFor information on the number of rules you can have in a security list, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the security\nlist to reside. Notice that the security list doesn't have to be in the same compartment as the VCN, subnets,\nor other Networking Service components. If you're not sure which compartment to use, put the security\nlist in the same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the security list, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id} > actions: AttachService",
|
|
"api_call": "POST /serviceGateways/{serviceGatewayId}/actions/attachService",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Adds the specified [Service](#/en/iaas/latest/Service/) to the list of enabled\n`Service` objects for the specified gateway. You must also set up a route rule with the\n`cidrBlock` of the `Service` as the rule's destination and the service gateway as the rule's\ntarget. See [Route Table](#/en/iaas/latest/RouteTable/).\n\n**Note:** The `AttachServiceId` operation is an easy way to add an individual `Service` to\nthe service gateway. Compare it with\n[UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces\nthe entire existing list of enabled `Service` objects with the list that you provide in the\n`Update` call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id} > actions: ChangeServiceGatewayCompartment",
|
|
"api_call": "POST /serviceGateways/{serviceGatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Moves a service gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id} > actions: DetachService",
|
|
"api_call": "POST /serviceGateways/{serviceGatewayId}/actions/detachService",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Removes the specified [Service](#/en/iaas/latest/Service/) from the list of enabled\n`Service` objects for the specified gateway. You do not need to remove any route\nrules that specify this `Service` object's `cidrBlock` as the destination CIDR. However, consider\nremoving the rules if your intent is to permanently disable use of the `Service` through this\nservice gateway.\n\n**Note:** The `DetachServiceId` operation is an easy way to remove an individual `Service` from\nthe service gateway. Compare it with\n[UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces\nthe entire existing list of enabled `Service` objects with the list that you provide in the\n`Update` call. `UpdateServiceGateway` also lets you block all traffic through the service\ngateway without having to remove each of the individual `Service` objects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id}: DeleteServiceGateway",
|
|
"api_call": "DELETE /serviceGateways/{serviceGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Deletes the specified service gateway. There must not be a route table that lists the service\ngateway as a target.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id}: GetServiceGateway",
|
|
"api_call": "GET /serviceGateways/{serviceGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Gets the specified service gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id}: UpdateServiceGateway",
|
|
"api_call": "PUT /serviceGateways/{serviceGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Updates the specified service gateway. The information you provide overwrites the existing\nattributes of the gateway.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways: ListServiceGateways",
|
|
"api_call": "GET /serviceGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID\nto filter the results by VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways: CreateServiceGateway",
|
|
"api_call": "POST /serviceGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new service gateway in the specified compartment.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe service gateway to reside. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the service gateway, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - services: ListServices",
|
|
"api_call": "GET /services",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the available [Service](#/en/iaas/latest/Service/) objects that you can enable for a\nservice gateway in this region.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - services: GetService",
|
|
"api_call": "GET /services/{serviceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"serviceId": "[REQUIRED] string: (Required) The service's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Gets the specified [Service](#/en/iaas/latest/Service/) object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: DeleteSubnet",
|
|
"api_call": "DELETE /subnets/{subnetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous\noperation. The subnet's `lifecycleState` will change to TERMINATING temporarily. If there are any\ninstances in the subnet, the state will instead change back to AVAILABLE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: GetSubnet",
|
|
"api_call": "GET /subnets/{subnetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Gets the specified subnet's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: UpdateSubnet",
|
|
"api_call": "PUT /subnets/{subnetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Updates the specified subnet.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: ChangeSubnetCompartment",
|
|
"api_call": "POST /subnets/{subnetId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Moves a subnet into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets: ListSubnets",
|
|
"api_call": "GET /subnets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the subnets in the specified VCN and the specified compartment.\nIf the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets: CreateSubnet",
|
|
"api_call": "POST /subnets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation,\nso it's important to think about the size of subnets you need before creating them.\nFor more information, see [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm).\nFor information on the number of subnets you can have in a VCN, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the subnet\nto reside. Notice that the subnet doesn't have to be in the same compartment as the VCN, route tables, or\nother Networking Service components. If you're not sure which compartment to use, put the subnet in\nthe same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs,\nsee [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally associate a route table with the subnet. If you don't, the subnet will use the\nVCN's default route table. For more information about route tables, see\n[Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n\nYou may optionally associate a security list with the subnet. If you don't, the subnet will use the\nVCN's default security list. For more information about security lists, see\n[Security Lists](/iaas/Content/Network/Concepts/securitylists.htm).\n\nYou may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the\nVCN's default set. For more information about DHCP options, see\n[DHCP Options](/iaas/Content/Network/Tasks/managingDHCP.htm).\n\nYou may optionally specify a *display name* for the subnet, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nYou can also add a DNS label for the subnet, which is required if you want the Internet and\nVCN Resolver to resolve hostnames for instances in the subnet. For more information, see\n[DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: AddVcnCidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/addCidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Adds a CIDR block to a VCN. The CIDR block you add:\n\n- Must be valid.\n- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.\n- Must not exceed the limit of CIDR blocks allowed per VCN.\n\n**Note:** Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: AddVcnIpv6Cidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/addIpv6Cidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Add an IPv6 CIDR to a VCN. The VCN size is always /56.\nAddVcnIpv6CidrDetails provides flexibility to have different private and public IPv6 address space.\nOnce added the IPv6 CIDR block cannot be removed or modified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: ChangeVcnCompartment",
|
|
"api_call": "POST /vcns/{vcnId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Moves a VCN into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: ModifyVcnCidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/modifyCidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria:\n\n- Must be valid.\n- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.\n- Must not exceed the limit of CIDR blocks allowed per VCN.\n- Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules.\n- No IP address in an existing subnet should be outside of the new CIDR block range.\n\n**Note:** Modifying a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can vary depending on the size of your network. Updating a small network could take about a minute, and updating a large network could take up to an hour. You can use the `GetWorkRequest` operation to check the status of the update.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: RemoveVcnCidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/removeCidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Removes a specified CIDR block from a VCN.\n\n**Notes:**\n- You cannot remove a CIDR block if an IP address in its range is in use.\n- Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id}: DeleteVcn",
|
|
"api_call": "DELETE /vcns/{vcnId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Deletes the specified VCN. The VCN must be empty and have no attached gateways. This is an asynchronous\noperation. The VCN's `lifecycleState` will change to TERMINATING temporarily until the VCN is completely\nremoved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id}: GetVcn",
|
|
"api_call": "GET /vcns/{vcnId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Gets the specified VCN's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id}: UpdateVcn",
|
|
"api_call": "PUT /vcns/{vcnId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Updates the specified VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns: ListVcns",
|
|
"api_call": "GET /vcns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the virtual cloud networks (VCNs) in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns: CreateVcn",
|
|
"api_call": "POST /vcns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new virtual cloud network (VCN). For more information, see\n[VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm).\n\nFor the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria:\n\n- The CIDR blocks must be valid.\n- They must not overlap with each other or with the on-premises network CIDR block. \n- The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN.\n\nFor a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in [RFC 1918](https://tools.ietf.org/html/rfc1918) (10.0.0.0/8, 172.16/12, and 192.168/16). Example:\n172.16.0.0/16. The CIDR blocks can range from /16 to /30.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the VCN to\nreside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which\ncompartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other\nNetworking Service components. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the VCN, otherwise a default is provided. It does not have to\nbe unique, and you can change it. Avoid entering confidential information.\n\nYou can also add a DNS label for the VCN, which is required if you want the instances to use the\nInterent and VCN Resolver option for DNS in the VCN. For more information, see\n[DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm).\n\nThe VCN automatically comes with a default route table, default security list, and default set of DHCP options.\nThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) for each is returned in the response. You can't delete these default objects, but you can change their\ncontents (that is, change the route rules, security list rules, and so on).\n\nThe VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN\nor FastConnect. For more information, see\n[Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id} > actions: BulkAddVirtualCircuitPublicPrefixes",
|
|
"api_call": "POST /virtualCircuits/{virtualCircuitId}/actions/bulkAddPublicPrefixes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Adds one or more customer public IP prefixes to the specified public virtual circuit.\nUse this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit))\nto add prefixes to the virtual circuit. Oracle must verify the customer's ownership\nof each prefix before traffic for that prefix will flow across the virtual circuit.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id} > actions: BulkDeleteVirtualCircuitPublicPrefixes",
|
|
"api_call": "POST /virtualCircuits/{virtualCircuitId}/actions/bulkDeletePublicPrefixes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Removes one or more customer public IP prefixes from the specified public virtual circuit.\nUse this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit))\nto remove prefixes from the virtual circuit. When the virtual circuit's state switches\nback to PROVISIONED, Oracle stops advertising the specified prefixes across the connection.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id} > actions: ChangeVirtualCircuitCompartment",
|
|
"api_call": "POST /virtualCircuits/{virtualCircuitId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Moves a virtual circuit into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: DeleteVirtualCircuit",
|
|
"api_call": "DELETE /virtualCircuits/{virtualCircuitId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Deletes the specified virtual circuit.\n\n**Important:** If you're using FastConnect via a provider,\nmake sure to also terminate the connection with\nthe provider, or else the provider may continue to bill you.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: GetVirtualCircuit",
|
|
"api_call": "GET /virtualCircuits/{virtualCircuitId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Gets the specified virtual circuit's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: UpdateVirtualCircuit",
|
|
"api_call": "PUT /virtualCircuits/{virtualCircuitId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Updates the specified virtual circuit. This can be called by\neither the customer who owns the virtual circuit, or the\nprovider (when provisioning or de-provisioning the virtual\ncircuit from their end). The documentation for\n[UpdateVirtualCircuitDetails](#/en/iaas/latest/requests/UpdateVirtualCircuitDetails)\nindicates who can update each property of the virtual circuit.\n\n**Important:** If the virtual circuit is working and in the\nPROVISIONED state, updating any of the network-related properties\n(such as the DRG being used, the BGP ASN, and so on) will cause the virtual\ncircuit's state to switch to PROVISIONING and the related BGP\nsession to go down. After Oracle re-provisions the virtual circuit,\nits state will return to PROVISIONED. Make sure you confirm that\nthe associated BGP session is back up. For more information\nabout the various states and how to test connectivity, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nTo change the list of public IP prefixes for a public virtual circuit,\nuse [BulkAddVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkAddVirtualCircuitPublicPrefixes)\nand\n[BulkDeleteVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkDeleteVirtualCircuitPublicPrefixes).\nUpdating the list of prefixes does NOT cause the BGP session to go down. However,\nOracle must verify the customer's ownership of each added prefix before\ntraffic for that prefix will flow across the virtual circuit.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: ListVirtualCircuitPublicPrefixes",
|
|
"api_call": "GET /virtualCircuits/{virtualCircuitId}/publicPrefixes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"verificationState": "string: A filter to only return resources that match the given verification\nstate.\n\nThe state value is case-insensitive.\n",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Lists the public IP prefixes and their details for the specified\npublic virtual circuit.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits: ListVirtualCircuits",
|
|
"api_call": "GET /virtualCircuits",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the virtual circuits in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits: CreateVirtualCircuit",
|
|
"api_call": "POST /virtualCircuits",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new virtual circuit to use with Oracle Cloud\nInfrastructure FastConnect. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the virtual circuit to reside. If you're\nnot sure which compartment to use, put the virtual circuit in the\nsame compartment with the DRG it's using. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the virtual circuit.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\n**Important:** When creating a virtual circuit, you specify a DRG for\nthe traffic to flow through. Make sure you attach the DRG to your\nVCN and confirm the VCN's routing sends traffic to the DRG. Otherwise\ntraffic will not flow. For more information, see\n[Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: DeleteVlan",
|
|
"api_call": "DELETE /vlans/{vlanId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Deletes the specified VLAN, but only if there are no VNICs in the VLAN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: GetVlan",
|
|
"api_call": "GET /vlans/{vlanId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Gets the specified VLAN's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: UpdateVlan",
|
|
"api_call": "PUT /vlans/{vlanId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Updates the specified VLAN. Note that this operation might require changes to all\nthe VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: ChangeVlanCompartment",
|
|
"api_call": "POST /vlans/{vlanId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Moves a VLAN into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans: ListVlans",
|
|
"api_call": "GET /vlans",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the VLANs in the specified VCN and the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans: CreateVlan",
|
|
"api_call": "POST /vlans",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a VLAN in the specified VCN and the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments > {vnic Attachment Id}: DetachVnic",
|
|
"api_call": "DELETE /vnicAttachments/{vnicAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vnicAttachmentId": "[REQUIRED] string: (Required) The OCID of the VNIC attachment."
|
|
},
|
|
"functionality": "Detaches and deletes the specified secondary VNIC.\nThis operation cannot be used on the instance's primary VNIC.\nWhen you terminate an instance, all attached VNICs (primary\nand secondary) are automatically detached and deleted.\n\n**Important:** If the VNIC has a\n[private IP](#/en/iaas/latest/PrivateIp/) that is the\n[target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),\ndeleting the VNIC causes that route rule to blackhole and the traffic\nwill be dropped.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments > {vnic Attachment Id}: GetVnicAttachment",
|
|
"api_call": "GET /vnicAttachments/{vnicAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vnicAttachmentId": "[REQUIRED] string: (Required) The OCID of the VNIC attachment."
|
|
},
|
|
"functionality": "Gets the information for the specified VNIC attachment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments: ListVnicAttachments",
|
|
"api_call": "GET /vnicAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"vnicId": "string: The OCID of the VNIC."
|
|
},
|
|
"functionality": "Lists the VNIC attachments in the specified compartment. A VNIC attachment\nresides in the same compartment as the attached instance. The list can be\nfiltered by instance, VNIC, or availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments: AttachVnic",
|
|
"api_call": "POST /vnicAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a secondary VNIC and attaches it to the specified instance.\nFor more information about secondary VNICs, see\n[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnics/{vnic Id}: GetVnic",
|
|
"api_call": "GET /vnics/{vnicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vnicId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC."
|
|
},
|
|
"functionality": "Gets the information for the specified virtual network interface card (VNIC).\nYou can get the VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm) from the\n[ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnics/{vnic Id}: UpdateVnic",
|
|
"api_call": "PUT /vnics/{vnicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vnicId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC."
|
|
},
|
|
"functionality": "Updates the specified VNIC.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments > {volume Attachment Id}: DetachVolume",
|
|
"api_call": "DELETE /volumeAttachments/{volumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the volume attachment."
|
|
},
|
|
"functionality": "Detaches a storage volume from an instance. You must specify the OCID of the volume attachment.\n\nThis is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily\nuntil the attachment is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments > {volume Attachment Id}: GetVolumeAttachment",
|
|
"api_call": "GET /volumeAttachments/{volumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the volume attachment."
|
|
},
|
|
"functionality": "Gets information about the specified volume attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments > {volume Attachment Id}: UpdateVolumeAttachment",
|
|
"api_call": "PUT /volumeAttachments/{volumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the volume attachment."
|
|
},
|
|
"functionality": "Updates information about the specified volume attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments: ListVolumeAttachments",
|
|
"api_call": "GET /volumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"volumeId": "string: The OCID of the volume."
|
|
},
|
|
"functionality": "Lists the volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, volume OCID, or both.\n\nCurrently, the only supported volume attachment type are [IScsiVolumeAttachment](#/en/iaas/latest/IScsiVolumeAttachment/) and\n[ParavirtualizedVolumeAttachment](#/en/iaas/latest/ParavirtualizedVolumeAttachment/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments: AttachVolume",
|
|
"api_call": "POST /volumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Attaches the specified storage volume to the specified instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies > {policy Id}: DeleteVolumeBackupPolicy",
|
|
"api_call": "DELETE /volumeBackupPolicies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the volume backup policy."
|
|
},
|
|
"functionality": "Deletes a user defined backup policy.\n For more information about user defined backup policies,\n see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies).\n\n Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies > {policy Id}: GetVolumeBackupPolicy",
|
|
"api_call": "GET /volumeBackupPolicies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the volume backup policy."
|
|
},
|
|
"functionality": "Gets information for the specified volume backup policy.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies > {policy Id}: UpdateVolumeBackupPolicy",
|
|
"api_call": "PUT /volumeBackupPolicies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the volume backup policy."
|
|
},
|
|
"functionality": "Updates a user defined backup policy.\n For more information about user defined backup policies,\n see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies).\n\n Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies: ListVolumeBackupPolicies",
|
|
"api_call": "GET /volumeBackupPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"compartmentId": "string: The OCID of the compartment.\nIf no compartment is specified, the Oracle defined backup policies are listed.\n"
|
|
},
|
|
"functionality": "Lists all the volume backup policies available in the specified compartment.\n\nFor more information about Oracle defined backup policies and user defined backup policies,\nsee [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies: CreateVolumeBackupPolicy",
|
|
"api_call": "POST /volumeBackupPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new user defined backup policy.\n\nFor more information about Oracle defined backup policies and user defined backup policies,\nsee [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments > {policy Assignment Id}: DeleteVolumeBackupPolicyAssignment",
|
|
"api_call": "DELETE /volumeBackupPolicyAssignments/{policyAssignmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyAssignmentId": "[REQUIRED] string: (Required) The OCID of the volume backup policy assignment."
|
|
},
|
|
"functionality": "Deletes a volume backup policy assignment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments > {policy Assignment Id}: GetVolumeBackupPolicyAssignment",
|
|
"api_call": "GET /volumeBackupPolicyAssignments/{policyAssignmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyAssignmentId": "[REQUIRED] string: (Required) The OCID of the volume backup policy assignment."
|
|
},
|
|
"functionality": "Gets information for the specified volume backup policy assignment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments: GetVolumeBackupPolicyAssetAssignment",
|
|
"api_call": "GET /volumeBackupPolicyAssignments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"assetId": "string: (Required) The OCID of an asset (e.g. a volume).",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Gets the volume backup policy assignment for the specified volume. The\n`assetId` query parameter is required, and the returned list will contain at most\none item, since volume can only have one volume backup policy assigned at a time.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments: CreateVolumeBackupPolicyAssignment",
|
|
"api_call": "POST /volumeBackupPolicyAssignments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Assigns a volume backup policy to the specified volume. Note that a given volume can\nonly have one backup policy assigned to it. If this operation is used for a volume that already\nhas a different backup policy assigned, the prior backup policy will be silently unassigned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id} > actions: ChangeVolumeBackupCompartment",
|
|
"api_call": "POST /volumeBackups/{volumeBackupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Moves a volume backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id} > actions: CreateVolumeBackupCopy",
|
|
"api_call": "POST /volumeBackups/{volumeBackupId}/actions/copy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Creates a volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id}: DeleteVolumeBackup",
|
|
"api_call": "DELETE /volumeBackups/{volumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Deletes a volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id}: GetVolumeBackup",
|
|
"api_call": "GET /volumeBackups/{volumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Gets information for the specified volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id}: UpdateVolumeBackup",
|
|
"api_call": "PUT /volumeBackups/{volumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Updates the display name for the specified volume backup.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups: ListVolumeBackups",
|
|
"api_call": "GET /volumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the volume backups in the specified compartment. You can filter the results by volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups: CreateVolumeBackup",
|
|
"api_call": "POST /volumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new backup of the specified volume. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id} > actions: ChangeVolumeGroupBackupCompartment",
|
|
"api_call": "POST /volumeGroupBackups/{volumeGroupBackupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Moves a volume group backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id} > actions: CreateVolumeGroupBackupCopy",
|
|
"api_call": "POST /volumeGroupBackups/{volumeGroupBackupId}/actions/copy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Creates a volume group backup copy in specified region. For general information about volume group backups,\nsee [Overview of Block Volume Service Backups](/Content/Block/Concepts/blockvolumebackups.htm)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id}: DeleteVolumeGroupBackup",
|
|
"api_call": "DELETE /volumeGroupBackups/{volumeGroupBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Deletes a volume group backup. This operation deletes all the backups in\nthe volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id}: GetVolumeGroupBackup",
|
|
"api_call": "GET /volumeGroupBackups/{volumeGroupBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id}: UpdateVolumeGroupBackup",
|
|
"api_call": "PUT /volumeGroupBackups/{volumeGroupBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Updates the display name for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups: ListVolumeGroupBackups",
|
|
"api_call": "GET /volumeGroupBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"volumeGroupId": "string: The OCID of the volume group.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the volume group backups in the specified compartment. You can filter the results by volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups: CreateVolumeGroupBackup",
|
|
"api_call": "POST /volumeGroupBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new backup volume group of the specified volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: DeleteVolumeGroup",
|
|
"api_call": "DELETE /volumeGroups/{volumeGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: GetVolumeGroup",
|
|
"api_call": "GET /volumeGroups/{volumeGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Gets information for the specified volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: UpdateVolumeGroup",
|
|
"api_call": "PUT /volumeGroups/{volumeGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Updates the set of volumes in a volume group along with the display name. Use this operation\nto add or remove volumes in a volume group. Specify the full list of volume IDs to include in the\nvolume group. If the volume ID is not specified in the call, it will be removed from the volume group.\nAvoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: ChangeVolumeGroupCompartment",
|
|
"api_call": "POST /volumeGroups/{volumeGroupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Moves a volume group into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups: ListVolumeGroups",
|
|
"api_call": "GET /volumeGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the volume groups in the specified compartment and availability domain.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups: CreateVolumeGroup",
|
|
"api_call": "POST /volumeGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new volume group in the specified compartment.\nA volume group is a collection of volumes and may be created from a list of volumes, cloning an existing\nvolume group, or by restoring a volume group backup.\nYou may optionally specify a *display name* for the volume group, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id} > kms Key: DeleteVolumeKmsKey",
|
|
"api_call": "DELETE /volumes/{volumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Removes the specified volume's assigned Key Management encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id} > kms Key: GetVolumeKmsKey",
|
|
"api_call": "GET /volumes/{volumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Gets the Key Management encryption key assigned to the specified volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id} > kms Key: UpdateVolumeKmsKey",
|
|
"api_call": "PUT /volumes/{volumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Updates the specified volume with a new Key Management master encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: DeleteVolume",
|
|
"api_call": "DELETE /volumes/{volumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Deletes the specified volume. The volume cannot have an active connection to an instance.\nTo disconnect the volume from a connected instance, see\n[Disconnecting From a Volume](/iaas/Content/Block/Tasks/disconnectingfromavolume.htm).\n**Warning:** All data on the volume will be permanently lost when the volume is deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: GetVolume",
|
|
"api_call": "GET /volumes/{volumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Gets information for the specified volume.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: UpdateVolume",
|
|
"api_call": "PUT /volumes/{volumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Updates the specified volume's display name.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: ChangeVolumeCompartment",
|
|
"api_call": "POST /volumes/{volumeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Moves a volume into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes: ListVolumes",
|
|
"api_call": "GET /volumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the volumes in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes: CreateVolume",
|
|
"api_call": "POST /volumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from\n50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB).\nFor general information about block volumes, see\n[Overview of Block Volume Service](/iaas/Content/Block/Concepts/overview.htm).\n\nA volume and instance can be in separate compartments but must be in the same availability domain.\nFor information about access control and compartments, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about\navailability domains, see [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).\nTo get a list of availability domains, use the `ListAvailabilityDomains` operation\nin the Identity and Access Management Service API.\n\nYou may optionally specify a *display name* for the volume, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListAllowedPeerRegionsForRemotePeering",
|
|
"api_call": "GET /allowedPeerRegionsForRemotePeering",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header"
|
|
},
|
|
"functionality": "Lists the regions that support remote VCN peering (which is peering across regions).\nFor more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListComputeCapacityReservationInstanceShapes",
|
|
"api_call": "GET /computeCapacityReservationInstanceShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be reserved within the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListCrossConnectLocations",
|
|
"api_call": "GET /crossConnectLocations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the available FastConnect locations for cross-connect installation. You need\nthis information so you can specify your desired location when you create a cross-connect.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListCrossConnectPortSpeedShapes",
|
|
"api_call": "GET /crossConnectPortSpeedShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the available port speeds for cross-connects. You need this information\nso you can specify your desired port speed (that is, shape) when you create a\ncross-connect.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListDedicatedVmHostInstanceShapes",
|
|
"api_call": "GET /dedicatedVmHostInstanceShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"dedicatedVmHostShape": "string: Dedicated VM host shape name\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.\nYou can filter the list by compatibility with a specific dedicated virtual machine host shape.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListDedicatedVmHostShapes",
|
|
"api_call": "GET /dedicatedVmHostShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"instanceShapeName": "string: The name for the instance's shape.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: Get a Virtual Networking topology for the current region",
|
|
"api_call": "GET /networkingTopology",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-none-match": "string: For querying if there is a cached value on the server. The If-None-Match HTTP request header \nmakes the request conditional. For GET and HEAD methods, the server will send back the requested \nresource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nFor other methods, the request will be processed only if the eventually existing resource's \nETag doesn't match any of the values listed.\n",
|
|
"cache-control": "string: The Cache-Control HTTP header holds directives (instructions)\nfor caching in both requests and responses.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"accessLevel": "string: Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`.\nSetting this to `ACCESSIBLE` returns only compartments for which a\nuser has INSPECT permissions, either directly or indirectly (permissions can be on a\nresource in a subcompartment). A restricted set of fields is returned for compartments in which a user has\nindirect INSPECT permissions.\n\nWhen set to `ANY` permissions are not checked.\n",
|
|
"queryCompartmentSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand the specified compartment and its subcompartments are\ninspected depending on the the setting of `accessLevel`.\nDefault is false.\n"
|
|
},
|
|
"functionality": "Gets a virtual networking topology for the current region.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListShapes",
|
|
"api_call": "GET /shapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be used to launch an instance within the specified compartment. You can\nfilter the list by compatibility with a specific image.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: Get Virtual Network VCN topology",
|
|
"api_call": "GET /vcnTopology",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-none-match": "string: For querying if there is a cached value on the server. The If-None-Match HTTP request header \nmakes the request conditional. For GET and HEAD methods, the server will send back the requested \nresource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nFor other methods, the request will be processed only if the eventually existing resource's \nETag doesn't match any of the values listed.\n",
|
|
"cache-control": "string: The Cache-Control HTTP header holds directives (instructions)\nfor caching in both requests and responses.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"accessLevel": "string: Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`.\nSetting this to `ACCESSIBLE` returns only compartments for which a\nuser has INSPECT permissions, either directly or indirectly (permissions can be on a\nresource in a subcompartment). A restricted set of fields is returned for compartments in which a user has\nindirect INSPECT permissions.\n\nWhen set to `ANY` permissions are not checked.\n",
|
|
"queryCompartmentSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand the specified compartment and its subcompartments are\ninspected depending on the the setting of `accessLevel`.\nDefault is false.\n",
|
|
"vcnId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Gets a virtual network topology for a given VCN.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListVirtualCircuitBandwidthShapes",
|
|
"api_call": "GET /virtualCircuitBandwidthShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "The deprecated operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - Model - Instance: Gets information about the specified instance",
|
|
"api_call": "GET /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string",
|
|
"compartmentId": "string: (Required) The OCID of the Compartment",
|
|
"instanceId": "[REQUIRED] string: (Required) The OCID of the instance"
|
|
},
|
|
"functionality": "Gets information about the specified instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - Model - Instance: Lists the instances",
|
|
"api_call": "GET /instances/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string",
|
|
"compartmentId": "string: (Required) The OCID of the Compartment"
|
|
},
|
|
"functionality": "Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id} > actions: CancelJobRun",
|
|
"api_call": "POST /jobRuns/{jobRunId}/actions/cancelJobRun",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Cancels an IN_PROGRESS job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id} > actions: ChangeJobRunCompartment",
|
|
"api_call": "POST /jobRuns/{jobRunId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Changes a job run's compartment",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id}: DeleteJobRun",
|
|
"api_call": "DELETE /jobRuns/{jobRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Deletes a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id}: GetJobRun",
|
|
"api_call": "GET /jobRuns/{jobRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Gets a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id}: UpdateJobRun",
|
|
"api_call": "PUT /jobRuns/{jobRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Updates a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs: ListJobRuns",
|
|
"api_call": "GET /jobRuns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"jobId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
|
|
},
|
|
"functionality": "List out job runs.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs: CreateJobRun",
|
|
"api_call": "POST /jobRuns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id} > artifact > content: GetJobArtifactContent",
|
|
"api_call": "GET /jobs/{jobId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"range": "string: Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7232#section-2.1), section 2.1.\nNote that only a single range of bytes is supported.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Downloads job artifact content for specified job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id} > artifact > content: HeadJobArtifact",
|
|
"api_call": "HEAD /jobs/{jobId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Gets job artifact metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id} > artifact: CreateJobArtifact",
|
|
"api_call": "POST /jobs/{jobId}/artifact",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"content-disposition": "string: This header allows you to specify a filename during upload. This file name is used to dispose of the file contents\nwhile downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file\nname when downloading.\nExample: `{\"Content-Disposition\": \"attachment\"\n \"filename\"=\"model.tar.gz\"\n \"Content-Length\": \"2347\"\n \"Content-Type\": \"application/gzip\"}`\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Uploads a job artifact.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: DeleteJob",
|
|
"api_call": "DELETE /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"deleteRelatedJobRuns": "boolean: Delete all JobRuns associated with this job.",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Deletes a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: GetJob",
|
|
"api_call": "GET /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Gets a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: UpdateJob",
|
|
"api_call": "PUT /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Updates a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: ChangeJobCompartment",
|
|
"api_call": "POST /jobs/{jobId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Changes a job's compartment",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs: ListJobs",
|
|
"api_call": "GET /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\n state for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "List jobs in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs: CreateJob",
|
|
"api_call": "POST /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id} > actions: Activates the model deployment.",
|
|
"api_call": "POST /modelDeployments/{modelDeploymentId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Activates the model deployment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id} > actions: Moves a model deployment into a different compartment.",
|
|
"api_call": "POST /modelDeployments/{modelDeploymentId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Moves a model deployment into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id} > actions: Deactivates the model deployment.",
|
|
"api_call": "POST /modelDeployments/{modelDeploymentId}/actions/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Deactivates the model deployment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id}: Deletes the model deployment.",
|
|
"api_call": "DELETE /modelDeployments/{modelDeploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Deletes the specified model deployment. Any unsaved work in this model deployment is lost.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id}: Gets the model deployment.",
|
|
"api_call": "GET /modelDeployments/{modelDeploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Retrieves the model deployment for the specified `modelDeploymentId`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id}: Updates the model deployment.",
|
|
"api_call": "PUT /modelDeployments/{modelDeploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Updates the properties of a model deployment. Some of the properties of `modelDeploymentConfigurationDetails` or `CategoryLogDetails` can also be updated with zero down time\nwhen the model deployment\u2019s lifecycle state is ACTIVE or NEEDS_ATTENTION i.e `instanceShapeName`, `instanceCount` and `modelId`, separately `loadBalancerShape` or `CategoryLogDetails`\ncan also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model\ndeployment is activated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments: Lists the model deployments.",
|
|
"api_call": "GET /modelDeployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists all model deployments in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments: Creates a new model deployment.",
|
|
"api_call": "POST /modelDeployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new model deployment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > actions: ActivateModel",
|
|
"api_call": "POST /models/{modelId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Activates the model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > actions: ChangeModelCompartment",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Moves a model resource into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > actions: DeactivateModel",
|
|
"api_call": "POST /models/{modelId}/actions/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Deactivates the model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > artifact > content: GetModelArtifactContent",
|
|
"api_call": "GET /models/{modelId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"range": "string: Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7232#section-2.1), section 2.1.\nNote that only a single range of bytes is supported.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Downloads model artifact content for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > artifact > content: HeadModelArtifact",
|
|
"api_call": "HEAD /models/{modelId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Gets model artifact metadata for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > artifact: CreateModelArtifact",
|
|
"api_call": "POST /models/{modelId}/artifact",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"content-disposition": "string: This header allows you to specify a filename during upload. This file name is used to dispose of the file contents\nwhile downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file\nname when downloading.\nExample: `{\"Content-Disposition\": \"attachment\"\n \"filename\"=\"model.tar.gz\"\n \"Content-Length\": \"2347\"\n \"Content-Type\": \"application/gzip\"}`\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Creates model artifact for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > provenance: GetModelProvenance",
|
|
"api_call": "GET /models/{modelId}/provenance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Gets provenance information for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > provenance: CreateModelProvenance",
|
|
"api_call": "POST /models/{modelId}/provenance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Creates provenance information for the specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > provenance: UpdateModelProvenance",
|
|
"api_call": "PUT /models/{modelId}/provenance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Updates the provenance information for the specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id}: DeleteModel",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Deletes the specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id}: GetModel",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Gets the specified model's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id}: UpdateModel",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Updates the properties of a model. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models: ListModels",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists models in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models: CreateModel",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id} > actions: ActivateNotebookSession",
|
|
"api_call": "POST /notebookSessions/{notebookSessionId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Activates the notebook session.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id} > actions: ChangeNotebookSessionCompartment",
|
|
"api_call": "POST /notebookSessions/{notebookSessionId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Moves a notebook session resource into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id} > actions: DeactivateNotebookSession",
|
|
"api_call": "POST /notebookSessions/{notebookSessionId}/actions/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Deactivates the notebook session.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id}: DeleteNotebookSession",
|
|
"api_call": "DELETE /notebookSessions/{notebookSessionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Deletes the specified notebook session. Any unsaved work in this notebook session are lost.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id}: GetNotebookSession",
|
|
"api_call": "GET /notebookSessions/{notebookSessionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Gets the specified notebook session's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id}: UpdateNotebookSession",
|
|
"api_call": "PUT /notebookSessions/{notebookSessionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Updates the properties of a notebook session. You can update the `displayName`, `freeformTags`, and `definedTags` properties.\nWhen the notebook session is in the INACTIVE lifecycle state, you can update `notebookSessionConfigurationDetails` and change `shape`, `subnetId`, and `blockStorageSizeInGBs`.\nChanges to the `notebookSessionConfigurationDetails` take effect the next time the `ActivateNotebookSession` action is invoked on the notebook session resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions: ListNotebookSessions",
|
|
"api_call": "GET /notebookSessions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the notebook sessions in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions: CreateNotebookSession",
|
|
"api_call": "POST /notebookSessions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new notebook session.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: DeleteProject",
|
|
"api_call": "DELETE /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: GetProject",
|
|
"api_call": "GET /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Gets the specified project's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: UpdateProject",
|
|
"api_call": "PUT /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Updates the properties of a project. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: ChangeProjectCompartment",
|
|
"api_call": "POST /projects/{projectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Moves a project resource into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects: ListProjects",
|
|
"api_call": "GET /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists projects in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects: CreateProject",
|
|
"api_call": "POST /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: CancelWorkRequest",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Cancels a work request that has not started.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: GetWorkRequest",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Gets the specified work request's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: ListWorkRequestErrors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Lists work request errors for the specified work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: ListWorkRequestLogs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Lists work request logs for the specified work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests: ListWorkRequests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"operationType": "string: <b>Filter</b> results by the type of the operation associated with the work request.",
|
|
"status": "string: <b>Filter</b> results by work request status.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.\n"
|
|
},
|
|
"functionality": "Lists work requests in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: ListJobShapes",
|
|
"api_call": "GET /jobShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n"
|
|
},
|
|
"functionality": "List job shapes available in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: Lists the valid model deployment shapes.",
|
|
"api_call": "GET /modelDeploymentShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n"
|
|
},
|
|
"functionality": "Lists the valid model deployment shapes.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: ListNotebookSessionShapes",
|
|
"api_call": "GET /notebookSessionShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n"
|
|
},
|
|
"functionality": "Lists the valid notebook session shapes.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: EXAMPLE Model Invoke",
|
|
"api_call": "POST /{data_science_model_deployment_ocid}/predict",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"x-content-sha256": "string",
|
|
"Content-Type": "string",
|
|
"Authorization": "string",
|
|
"Date": "string",
|
|
"data_science_model_deployment_ocid": "[REQUIRED] string"
|
|
},
|
|
"functionality": "",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Moves an Digital Assistant instance into a different compartment.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against\nETag values of the resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Configure the Digital Assistant Parameters for the Digital Assistant instance",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/configureDigitalAssistantParameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Import Bot",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/importBot",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Import a Bot archive from Object Storage.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Starts an inactive Digital Assistant instance.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering\nof requests will be started again.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Stops an active Digital Assistant instance.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering\nof requests will be stopped until the instance is started again. Data associated with the instance\nis not affected.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments > {attachment Id}: Delete a Digital Assistant instance attachment",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/attachments/{attachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"attachmentId": "[REQUIRED] string: (Required) Unique Digital Assistant instance attachment identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to delete the specified Digital Assistant instance attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments > {attachment Id}: Get ODA instance attachment information",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/attachments/{attachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"includeOwnerMetadata": "boolean: Whether to send attachment owner info during get/list call.",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"attachmentId": "[REQUIRED] string: (Required) Unique Digital Assistant instance attachment identifier."
|
|
},
|
|
"functionality": "Gets an ODA instance attachment by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments > {attachment Id}: Update the ODA instance attachment identified by the ID",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/attachments/{attachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"attachmentId": "[REQUIRED] string: (Required) Unique Digital Assistant instance attachment identifier."
|
|
},
|
|
"functionality": "Updates the ODA instance attachment",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments: Gets a list of all attachments to an ODA instance",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/attachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a list of ODA instance attachments\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments: Create Digital Assistant Instance Attachment",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/attachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to create a Digital Assistant instance attachment.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers > {authentication Provider Id}: Delete Authentication Provider",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"authenticationProviderId": "[REQUIRED] string: (Required) Unique Authentication Provider identifier."
|
|
},
|
|
"functionality": "Delete the specified Authentication Provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers > {authentication Provider Id}: Get Authentication Provider",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"authenticationProviderId": "[REQUIRED] string: (Required) Unique Authentication Provider identifier."
|
|
},
|
|
"functionality": "Gets the specified Authentication Provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers > {authentication Provider Id}: Update Authentication Provider",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"authenticationProviderId": "[REQUIRED] string: (Required) Unique Authentication Provider identifier."
|
|
},
|
|
"functionality": "Updates the specified Authentication Provider with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers: List Authentication Providers",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/authenticationProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers: Create Authentication Provider",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/authenticationProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Authentication Provider\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id} > actions: Rotate generated keys for the Channel.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels/{channelId}/actions/rotateKeys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken).\nIf a Channel has no generated keys then no changes will be made.\nEnsure that you take note of the newly generated keys in the response as they will not be returned again.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id} > actions: Start a Channel.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels/{channelId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Starts a Channel so that it will begin accepting messages.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id} > actions: Stop a Channel.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels/{channelId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Stops a Channel so that it will no longer accept messages.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id}: Delete Channel",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/channels/{channelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Delete the specified Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id}: Get Channel",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/channels/{channelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Gets the specified Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id}: Update Channel",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/channels/{channelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Updates the specified Channel with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels: List Channels",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/channels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Channels that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels: Create Channel",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Channel.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > actions: Export a Digital Assistant to Object Storage",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/export",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Exports the specified Digital Assistant as an archive to Object Storage.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > actions: Publish Digital Assistant",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/publish",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Publish a draft Digital Assistant.\nOnce published the Digital Assistant cannot be modified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > parameters > {parameter Name}: Get Digital Assistant Parameter",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant."
|
|
},
|
|
"functionality": "Gets the specified Digital Assistant Parameter.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > parameters > {parameter Name}: Update Digital Assistant Parameter",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant."
|
|
},
|
|
"functionality": "Updates the specified Digital Assistant Parameter with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > parameters: List Digital Assistant Parameters",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Returns a page of Parameters that belong to the specified Digital Assistant.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id}: Delete Digital Assistant",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Delete the specified Digital Assistant.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id}: Get Digital Assistant",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Gets the specified Digital Assistant.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id}: Update Digital Assistant",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Updates the specified Digital Assistant with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants: List Digital Assistants",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants: Create Digital Assistant",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/digitalAssistants",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Digital Assistant.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages > {package Id}: Delete Package from Digital Assistant Instance",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/importedPackages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to delete a package from a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages > {package Id}: Get details for a package that has been imported into the given instance.",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/importedPackages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Returns a list of summaries for imported packages in the instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages > {package Id}: Update Package that has been imported into a Digital Assistant Instance",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/importedPackages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"isReplaceSkills": "boolean: Should old skills be replaced by new skills if packageId differs from already imported package?",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to update a package within a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages: List packages that have been imported into the given instance.",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/importedPackages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a list of summaries for imported packages in the instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages: Import Package into Digital Assistant Instance",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/importedPackages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to import a package into a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > actions: Export a Skill to Object Storage",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills/{skillId}/actions/export",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Exports the specified Skill as an archive to Object Storage.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > actions: Publish Skill",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills/{skillId}/actions/publish",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Publish a draft Skill.\nOnce published it cannot be modified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters > {parameter Name}: Delete Skill Parameter",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Skill Parameter."
|
|
},
|
|
"functionality": "Delete the specified Skill Parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters > {parameter Name}: Get Skill Parameter",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Skill Parameter."
|
|
},
|
|
"functionality": "Gets the specified Skill Parameter.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters > {parameter Name}: Update Skill Parameter",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Skill Parameter."
|
|
},
|
|
"functionality": "Updates the specified Skill Parameter with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters: List Skill Parameters",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills/{skillId}/parameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Returns a page of Skill Parameters that belong to the specified Skill.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters: Create Skill Parameter",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills/{skillId}/parameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Creates a new Skill Parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id}: Delete Skill",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/skills/{skillId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Delete the specified Skill.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id}: Get Skill",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills/{skillId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Gets the specified Skill.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id}: Update Skill",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/skills/{skillId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Updates the specified Skill with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills: List Skills",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Skills that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills: Create Skill",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Skill from scratch.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators > {translator Id}: Delete Translator",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/translators/{translatorId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"translatorId": "[REQUIRED] string: (Required) Unique Translator identifier."
|
|
},
|
|
"functionality": "Delete the specified Translator.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators > {translator Id}: Get Translator",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/translators/{translatorId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"translatorId": "[REQUIRED] string: (Required) Unique Translator identifier."
|
|
},
|
|
"functionality": "Gets the specified Translator.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators > {translator Id}: Update Translator",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/translators/{translatorId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"translatorId": "[REQUIRED] string: (Required) Unique Translator identifier."
|
|
},
|
|
"functionality": "Updates the specified Translator with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators: List Translators",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/translators",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Translators that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators: Create Translator",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/translators",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Translator\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Delete Digital Assistant Instance",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to delete the specified Digital Assistant instance.\nTo monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Get Digital Assistant Instance",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Gets the specified Digital Assistant instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Update Digital Assistant Instance",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Updates the specified Digital Assistant instance with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Get details for a given package",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/packages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Returns details about a package, and how to import it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances: Get Compartment's Digital Assistant Instances",
|
|
"api_call": "GET /odaInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) List the Digital Assistant instances that belong to this compartment.",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending)."
|
|
},
|
|
"functionality": "Returns a page of Digital Assistant instances that belong to the specified\ncompartment.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances: Create Digital Assistant Instance",
|
|
"api_call": "POST /odaInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Starts an asynchronous job to create a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests > {work Request Id}: Get Work Request",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The identifier of the asynchronous work request."
|
|
},
|
|
"functionality": "Gets information about the work request with the specified ID, including its status.\n\nYou can use this operation to monitor the status of jobs that you\nrequested to create, delete, and update instances.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests > {work Request Id}: List Work Request Errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.\n\nThe default sort order for both `TIMESTAMP` and `CODE` is ascending.\n",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The identifier of the asynchronous work request."
|
|
},
|
|
"functionality": "Returns a page of errors for the specified work request.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests > {work Request Id}: List Work Request Log Messages",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.\n\nThe default sort order for both `TIMESTAMP` and `MESSAGE` is ascending.\n",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The identifier of the asynchronous work request."
|
|
},
|
|
"functionality": "Returns a page of of log messages for a given work request.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests: List Compartment's Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) List the Digital Assistant instances that belong to this compartment."
|
|
},
|
|
"functionality": "Returns a page of work requests for the specified compartment.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - General: List packages available for import",
|
|
"api_call": "GET /packages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "string: List only the information for this Digital Assistant instance."
|
|
},
|
|
"functionality": "Returns a page of summaries for packages that are available for import. The optional odaInstanceId query\nparameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId\nquery parameter is not provided, the returned list will\ninclude packages available within the region indicated by the request URL. The optional resourceType query\nparam may be specified to filter packages that contain the indicated resource type. If no resourceType query\nparam is given, packages containing all resource types will be returned. The optional name query parameter can\nbe used to limit the list to packages whose name matches the given name. The optional displayName query\nparameter can be used to limit the list to packages whose displayName matches the given name. The optional\nisLatestVersionOnly query parameter can be used to limit the returned list to include only the latest version\nof any given package. If not specified, all versions of any otherwise matching package will be returned.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Document Understanding API - processor Jobs > {processor Job Id}: Get the details of a processor job.",
|
|
"api_call": "GET /processorJobs/{processorJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"processorJobId": "[REQUIRED] string: (Required) Processor job id."
|
|
},
|
|
"functionality": "Get the details of a processor job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Document Understanding API - processor Jobs > {processor Job Id}: Cancel a processor job.",
|
|
"api_call": "POST /processorJobs/{processorJobId}/actions/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"processorJobId": "[REQUIRED] string: (Required) Processor job id."
|
|
},
|
|
"functionality": "Cancel a processor job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Document Understanding API - processor Jobs: Create a processor job for document analysis.",
|
|
"api_call": "POST /processorJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a processor job for document analysis.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Retrieves a rule",
|
|
"api_call": "GET /rules/{ruleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Retrieves a rule.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Updates a rule",
|
|
"api_call": "PUT /rules/{ruleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Updates a rule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Deletes a rule",
|
|
"api_call": "DELETE /rules/{ruleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Deletes a rule.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Moves a rule into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"api_call": "POST /rules/{ruleId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Moves a rule into a different compartment within the same tenancy. For information about moving \nresources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules: Lists rules for this compartment.",
|
|
"api_call": "GET /rules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs.\n",
|
|
"limit": "integer: The maximum number of items to return. 1 is the minimum, 50 is the maximum.\nDefault: 10\n",
|
|
"lifecycleState": "string: A filter to return only rules that match the lifecycle state in this parameter.\n\nExample: `Creating`\n",
|
|
"sortBy": "string: Specifies the attribute with which to sort the rules.\n\nDefault: `timeCreated`\n\n* **TIME_CREATED:** Sorts by timeCreated.\n* **DISPLAY_NAME:** Sorts by displayName.\n* **ID:** Sorts by id.\n",
|
|
"sortOrder": "string: Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n"
|
|
},
|
|
"functionality": "Lists rules for this compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules: Creates a new rule",
|
|
"api_call": "POST /rules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new rule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Retrieves an application",
|
|
"api_call": "GET /applications/{applicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Retrieves an application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Modifies an application",
|
|
"api_call": "PUT /applications/{applicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Modifies an application",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Deletes an application",
|
|
"api_call": "DELETE /applications/{applicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Deletes an application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"api_call": "POST /applications/{applicationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Moves an application into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see [Moving Resources Between Compartments](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications: Lists applications for a compartment",
|
|
"api_call": "GET /applications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this resource belongs.\n",
|
|
"limit": "integer: The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n",
|
|
"sortOrder": "string: Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n",
|
|
"sortBy": "string: Specifies the attribute with which to sort the rules.\n\nDefault: `displayName`\n\n* **timeCreated:** Sorts by timeCreated.\n* **displayName:** Sorts by displayName.\n* **id:** Sorts by id.\n"
|
|
},
|
|
"functionality": "Lists applications for a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications: Creates a new application",
|
|
"api_call": "POST /applications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string"
|
|
},
|
|
"functionality": "Creates a new application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Retrieves a function",
|
|
"api_call": "GET /functions/{functionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Retrieves a function.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Modifies a function",
|
|
"api_call": "PUT /functions/{functionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Modifies a function",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Deletes a function",
|
|
"api_call": "DELETE /functions/{functionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Deletes a function.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Invokes a function",
|
|
"api_call": "POST //<unique_ID>.{region}.functions.oci.oraclecloud.com/20181201/functions/{functionId}/actions/invoke",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"region": "[REQUIRED] string",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Invokes a function",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions: Lists functions for an application",
|
|
"api_call": "GET /functions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"applicationId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application to which this function belongs.\n",
|
|
"limit": "integer: The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n",
|
|
"page": "string: The pagination token for a list query returned by a previous operation\n",
|
|
"sortOrder": "string: Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n",
|
|
"sortBy": "string: Specifies the attribute with which to sort the rules.\n\nDefault: `displayName`\n\n* **timeCreated:** Sorts by timeCreated.\n* **displayName:** Sorts by displayName.\n* **id:** Sorts by id.\n"
|
|
},
|
|
"functionality": "Lists functions for an application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions: Creates a new function",
|
|
"api_call": "POST /functions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string"
|
|
},
|
|
"functionality": "Creates a new function.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - actions > embedText: Produces embeddings (i.e. low-level numerical representation) of the inputs",
|
|
"api_call": "POST /actions/embedText",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**EmbedText**\n\nProduces embeddings (low-level numerical representation) of the inputs\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - actions > generateText: Generates text response based on the prompts",
|
|
"api_call": "POST /actions/generateText",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GenerateText**\n\nGenerates text response based on the prompts\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - actions > summarizeText: Summarizes text response based on the input",
|
|
"api_call": "POST /actions/summarizeText",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**SummarizeText**\n\nSummarizes text response based on the input\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId} > actions > changeCompartment: Moves a DedicatedAiCluster into a different compartment.",
|
|
"api_call": "POST /dedicatedAiClusters/{dedicatedAiClusterId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ChangeDedicatedAiClusterCompartment**\n\nMoves a dedicated AI cluster into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId}: Deletes a dedicated AI cluster.",
|
|
"api_call": "DELETE /dedicatedAiClusters/{dedicatedAiClusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**DeleteDedicatedAiCluster**\n\nDeletes a dedicated AI cluster.\n\nYou can only delete clusters without attached resources. Before you delete a dedicated AI cluster, you must delete the hosted models or endpoints attached to that cluster. The delete action permanently deletes the cluster. This action can't be undone.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId}: Get DedicatedAiCluster",
|
|
"api_call": "GET /dedicatedAiClusters/{dedicatedAiClusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetDedicatedAiCluster**\n\nGets information about a dedicated AI cluster.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId}: Updates a DedicatedAiCluster.",
|
|
"api_call": "PUT /dedicatedAiClusters/{dedicatedAiClusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**UpdateDedicatedAiCluster**\n\nUpdates a dedicated AI cluster.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters: Gets a list of DedicatedAiClusters.",
|
|
"api_call": "GET /dedicatedAiClusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"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`\nis descending. Default order for `displayName` is ascending.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListDedicatedAiClusters**\n\nLists the dedicated AI clusters in a specific compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters: Creates a DedicatedAiCluster.",
|
|
"api_call": "POST /dedicatedAiClusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**CreateDedicatedAiCluster**\n\nCreates a dedicated AI cluster.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId} > actions > changeCompartment: Moves an endpoint into a different compartment.",
|
|
"api_call": "POST /endpoints/{endpointId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ChangeEndpointCompartment**\n\nMoves an endpoint into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId}: Deletes an endpoint.",
|
|
"api_call": "DELETE /endpoints/{endpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**DeleteEndpoint**\n\nDeletes an endpoint.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId}: Get Endpoint",
|
|
"api_call": "GET /endpoints/{endpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetEndpoint**\n\nGets information about an endpoint.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId}: Updates a Endpoint.",
|
|
"api_call": "PUT /endpoints/{endpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**UpdateEndpoint**\n\nUpdates the properties of an endpoint.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints: Gets a list of Endpoints.",
|
|
"api_call": "GET /endpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"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`\nis descending. Default order for `displayName` is ascending.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListEndpoints**\n\nList the endpoints of a specific compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints: Creates a Endpoint.",
|
|
"api_call": "POST /endpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**CreateEndpoint**\n\nCreates an endpoint.\nHeaders contain opc-work-request-id that identifies a WorkRequest which tracks the Endpoint creation progress.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId} > actions > changeCompartment: Moves a Model into a different compartment.",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ChangeModelCompartment**\n\nMoves a custom model into a different compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId}: Deletes a Model.",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**DeleteModel**\n\nDeletes a custom model. A model shouldn't be deleted if there's one or more active endpoints associated with the model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId}: Retrieves a single model resource, providing basic information about the model",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetModel**\n\nGets information about a custom model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId}: Updates a Model.",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**UpdateModel**\n\nUpdates the properties of a custom model such as name, description, freeform tags and defined tags.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models: Lists the currently available models.",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"capability": "string: A filter to return only resources their capability matches the given capability.",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"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.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListModels**\n\nLists the models in a specific compartment. Includes both pretrained base models and fine-tuned custom models.\nModelCollection is to conform to OCI API consistency guidelines.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models: Creates a Model.",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**CreateModel**\n\nCreates a custom model to use for fine-tuning. \n\nHeaders contain opc-work-request-id that identifies a WorkRequest which tracks the Model creation progress.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests > {workRequestId} > errors: List work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListWorkRequestErrors**\n\nLists the errors for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests > {workRequestId} > logs: Lists the work request logs.",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListWorkRequestLogs**\n\nLists the logs for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests > {workRequestId}: Get work request status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetWorkRequest**\n\nGets the details of a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests: List work requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListWorkRequests**\n\nLists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - authentication Policies/{compartment Id}: GetAuthenticationPolicy",
|
|
"api_call": "GET /authenticationPolicies/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Gets the authentication policy for the given tenancy. You must specify your tenant\u2019s OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - authentication Policies/{compartment Id}: UpdateAuthenticationPolicy",
|
|
"api_call": "PUT /authenticationPolicies/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Updates authentication policy for the specified tenancy\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: Bulk delete resources in the compartment",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/bulkDeleteResources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate\npermissions to delete the resources in the request. This API can only be invoked from the tenancy's\n[home region](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingregions.htm#Home). This operation creates a\n[WorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/). Use the [GetWorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest)\nAPI to monitor the status of the bulk action.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: Move multiple resources at once to a different compartment.",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/bulkMoveResources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Moves multiple resources from one compartment to another. All resources must be in the same compartment.\nThis API can only be invoked from the tenancy's [home region](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingregions.htm#Home).\nTo move resources, you must have the appropriate permissions to move the resource in both the source and target\ncompartments. This operation creates a [WorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/).\nUse the [GetWorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) API to monitor the status of the bulk action.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: Moves a compartment tree to a different parent compartment. When provided,\nIf-Match is checked against ETag values of the resource.\n",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/moveCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Move the compartment to a different parent compartment in the same tenancy. When you move a\ncompartment, all its contents (subcompartments and resources) are moved with it. Note that\nthe `CompartmentId` that you specify in the path is the compartment that you want to move.\n\n**IMPORTANT**: After you move a compartment to a new parent compartment, the access policies of\nthe new parent take effect and the policies of the previous parent no longer apply. Ensure that you\nare aware of the implications for the compartment contents before you move it. For more\ninformation, see [Moving a Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#MoveCompartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: RecoverCompartment",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/recoverCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Recover the compartment from DELETED state to ACTIVE state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id}: DeleteCompartment",
|
|
"api_call": "DELETE /compartments/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Deletes the specified compartment. The compartment must be empty.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id}: GetCompartment",
|
|
"api_call": "GET /compartments/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Gets the specified compartment's information.\n\nThis operation does not return a list of all the resources inside the compartment. There is no single\nAPI operation that does that. Compartments can contain multiple types of resources (instances, block\nstorage volumes, etc.). To find out what's in a compartment, you must call the \"List\" operation for\neach resource type and specify the compartment's OCID as a query parameter in the request. For example,\ncall the [ListInstances](https://docs.oracle.com/iaas/api/#/en/iaas/20160918/Instance/ListInstances) operation in the Cloud Compute\nService or the [ListVolumes](https://docs.oracle.com/iaas/api/#/en/iaas/20160918/Volume/ListVolumes) operation in Cloud Block Storage.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id}: UpdateCompartment",
|
|
"api_call": "PUT /compartments/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Updates the specified compartment's description or name. You can't update the root compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments: ListCompartments",
|
|
"api_call": "GET /compartments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"accessLevel": "string: Valid values are `ANY` and `ACCESSIBLE`. Default is `ANY`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). For the compartments on which the user indirectly has\nINSPECT permissions, a restricted set of fields is returned.\n\nWhen set to `ANY` permissions are not checked.\n",
|
|
"compartmentIdInSubtree": "boolean: Default is false. Can only be set to true when performing\nListCompartments on the tenancy (root compartment).\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the the setting of `accessLevel`.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the compartments in a specified compartment. The members of the list\nreturned depends on the values set for several parameters.\n\nWith the exception of the tenancy (root compartment), the ListCompartments operation\nreturns only the first-level child compartments in the parent compartment specified in\n`compartmentId`. The list does not include any subcompartments of the child\ncompartments (grandchildren).\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (the resource can be in a subcompartment).\n\nThe parameter `compartmentIdInSubtree` applies only when you perform ListCompartments on the\ntenancy (root compartment). When set to true, the entire hierarchy of compartments can be returned.\nTo get a full list of all compartments and subcompartments in the tenancy (root compartment),\nset the parameter `compartmentIdInSubtree` to true and `accessLevel` to ANY.\n\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments: CreateCompartment",
|
|
"api_call": "POST /compartments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new compartment in the specified compartment.\n\n**Important:** Compartments cannot be deleted.\n\nSpecify the parent compartment's OCID as the compartment ID in the request object. Remember that the tenancy\nis simply the root compartment. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the compartment, which must be unique across all compartments in\nyour tenancy. You can use this name or the OCID when writing policies that apply\nto the compartment. For more information about policies, see\n[How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the compartment (although it can be an empty string). It does\nnot have to be unique, and you can change it anytime with\n[UpdateCompartment](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Compartment/UpdateCompartment).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments: ListBulkActionResourceTypes",
|
|
"api_call": "GET /compartments/bulkActionResourceTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bulkActionType": "string: (Required) The type of bulk action.\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the resource-types supported by compartment bulk actions. Use this API to help you provide the correct\nresource-type information to the [BulkDeleteResources](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Compartment/BulkDeleteResources/)\nand [BulkMoveResources](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Compartment/BulkMoveResources/) operations. The returned list of\nresource-types provides the appropriate resource-type names to use with the bulk action operations along with\nthe type of identifying information you'll need to provide for each resource-type. Most resource-types just\nrequire an [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) to identify a specific resource, but some resource-types,\nsuch as buckets, require you to provide other identifying information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups > {dynamic Group Id}: DeleteDynamicGroup",
|
|
"api_call": "DELETE /dynamicGroups/{dynamicGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dynamicGroupId": "[REQUIRED] string: (Required) The OCID of the dynamic group."
|
|
},
|
|
"functionality": "Deletes the specified dynamic group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups > {dynamic Group Id}: GetDynamicGroup",
|
|
"api_call": "GET /dynamicGroups/{dynamicGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dynamicGroupId": "[REQUIRED] string: (Required) The OCID of the dynamic group."
|
|
},
|
|
"functionality": "Gets the specified dynamic group's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups > {dynamic Group Id}: UpdateDynamicGroup",
|
|
"api_call": "PUT /dynamicGroups/{dynamicGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dynamicGroupId": "[REQUIRED] string: (Required) The OCID of the dynamic group."
|
|
},
|
|
"functionality": "Updates the specified dynamic group.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups: ListDynamicGroups",
|
|
"api_call": "GET /dynamicGroups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the dynamic groups in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups: CreateDynamicGroup",
|
|
"api_call": "POST /dynamicGroups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new dynamic group in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the dynamic group, which must be unique across all dynamic groups in your\ntenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy.\nYou can use this name or the OCID when writing policies that apply to the dynamic group. For more information\nabout policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the dynamic group (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdateDynamicGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/DynamicGroup/UpdateDynamicGroup).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups > {group Id}: DeleteGroup",
|
|
"api_call": "DELETE /groups/{groupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"groupId": "[REQUIRED] string: (Required) The OCID of the group."
|
|
},
|
|
"functionality": "Deletes the specified group. The group must be empty.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups > {group Id}: GetGroup",
|
|
"api_call": "GET /groups/{groupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"groupId": "[REQUIRED] string: (Required) The OCID of the group."
|
|
},
|
|
"functionality": "Gets the specified group's information.\n\nThis operation does not return a list of all the users in the group. To do that, use\n[ListUserGroupMemberships](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UserGroupMembership/ListUserGroupMemberships) and\nprovide the group's OCID as a query parameter in the request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups > {group Id}: UpdateGroup",
|
|
"api_call": "PUT /groups/{groupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"groupId": "[REQUIRED] string: (Required) The OCID of the group."
|
|
},
|
|
"functionality": "Updates the specified group.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups: ListGroups",
|
|
"api_call": "GET /groups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the groups in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups: CreateGroup",
|
|
"api_call": "POST /groups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new group in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the group, which must be unique across all groups in your tenancy and\ncannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more\ninformation about policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the group (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdateGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Group/UpdateGroup).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n\nAfter creating the group, you need to put users in it and write policies for it.\nSee [AddUserToGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UserGroupMembership/AddUserToGroup) and\n[CreatePolicy](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Policy/CreatePolicy).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings > {mapping Id}: DeleteIdpGroupMapping",
|
|
"api_call": "DELETE /identityProviders/{identityProviderId}/groupMappings/{mappingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider.",
|
|
"mappingId": "[REQUIRED] string: (Required) The OCID of the group mapping."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nDeletes the specified group mapping.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings > {mapping Id}: GetIdpGroupMapping",
|
|
"api_call": "GET /identityProviders/{identityProviderId}/groupMappings/{mappingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider.",
|
|
"mappingId": "[REQUIRED] string: (Required) The OCID of the group mapping."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nGets the specified group mapping.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings > {mapping Id}: UpdateIdpGroupMapping",
|
|
"api_call": "PUT /identityProviders/{identityProviderId}/groupMappings/{mappingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider.",
|
|
"mappingId": "[REQUIRED] string: (Required) The OCID of the group mapping."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nUpdates the specified group mapping.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings: ListIdpGroupMappings",
|
|
"api_call": "GET /identityProviders/{identityProviderId}/groupMappings/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists the group mappings for the specified identity provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings: CreateIdpGroupMapping",
|
|
"api_call": "POST /identityProviders/{identityProviderId}/groupMappings/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nCreates a single mapping between an IdP group and an IAM Service\n[group](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Group/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: DeleteIdentityProvider",
|
|
"api_call": "DELETE /identityProviders/{identityProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nDeletes the specified identity provider. The identity provider must not have\nany group mappings (see [IdpGroupMapping](https://docs.oracle.com/iaas/api/#/en/identity/20160918/IdpGroupMapping/)).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: GetIdentityProvider",
|
|
"api_call": "GET /identityProviders/{identityProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nGets the specified identity provider's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: UpdateIdentityProvider",
|
|
"api_call": "PUT /identityProviders/{identityProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nUpdates the specified identity provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: ResetIdpScimClient",
|
|
"api_call": "POST /identityProviders/{identityProviderId}/actions/resetScimClient/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: Gets the identity provider groups.",
|
|
"api_call": "GET /identityProviders/{identityProviderId}/groups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"name": "string: A filter to only return resources that match the given name exactly.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists the identity provider groups.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers: ListIdentityProviders",
|
|
"api_call": "GET /identityProviders/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"protocol": "string: (Required) The protocol used for federation.",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for\nidentity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the\ncompartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers: CreateIdentityProvider",
|
|
"api_call": "POST /identityProviders/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nCreates a new identity provider in your tenancy. For more information, see\n[Identity Providers and Federation](https://docs.oracle.com/iaas/Content/Identity/Concepts/federation.htm).\n\nYou must specify your tenancy's OCID as the compartment ID in the request object.\nRemember that the tenancy is simply the root compartment. For information about\nOCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the `IdentityProvider`, which must be unique\nacross all `IdentityProvider` objects in your tenancy and cannot be changed.\n\nYou must also specify a *description* for the `IdentityProvider` (although\nit can be an empty string). It does not have to be unique, and you can change\nit anytime with\n[UpdateIdentityProvider](https://docs.oracle.com/iaas/api/#/en/identity/20160918/IdentityProvider/UpdateIdentityProvider).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily\nbe CREATING. Before using the object, first make sure its `lifecycleState` has\nchanged to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources > {network Source Id}: DeleteNetworkSource",
|
|
"api_call": "DELETE /networkSources/{networkSourceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSourceId": "[REQUIRED] string: (Required) The OCID of the network source."
|
|
},
|
|
"functionality": "Deletes the specified network source\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources > {network Source Id}: GetNetworkSource",
|
|
"api_call": "GET /networkSources/{networkSourceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSourceId": "[REQUIRED] string: (Required) The OCID of the network source."
|
|
},
|
|
"functionality": "Gets the specified network source's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources > {network Source Id}: UpdateNetworkSource",
|
|
"api_call": "PUT /networkSources/{networkSourceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSourceId": "[REQUIRED] string: (Required) The OCID of the network source."
|
|
},
|
|
"functionality": "Updates the specified network source.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources: ListNetworkSources",
|
|
"api_call": "GET /networkSources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the network sources in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources: CreateNetworkSource",
|
|
"api_call": "POST /networkSources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new network source in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the network source, which must be unique across all network sources in your\ntenancy, and cannot be changed.\nYou can use this name or the OCID when writing policies that apply to the network source. For more information\nabout policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the network source (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdateNetworkSource](https://docs.oracle.com/iaas/api/#/en/identity/20160918/NetworkSource/UpdateNetworkSource).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n\nAfter your network resource is created, you can use it in policy to restrict access to only requests made from an allowed\nIP address specified in your network source. For more information, see [Managing Network Sources](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingnetworksources.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies > {policy Id}: DeletePolicy",
|
|
"api_call": "DELETE /policies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the policy."
|
|
},
|
|
"functionality": "Deletes the specified policy. The deletion takes effect typically within 10 seconds.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies > {policy Id}: GetPolicy",
|
|
"api_call": "GET /policies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the policy."
|
|
},
|
|
"functionality": "Gets the specified policy's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies > {policy Id}: UpdatePolicy",
|
|
"api_call": "PUT /policies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the policy."
|
|
},
|
|
"functionality": "Updates the specified policy. You can update the description or the policy statements themselves.\n\nPolicy changes take effect typically within 10 seconds.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies: ListPolicies",
|
|
"api_call": "GET /policies/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the policies in the specified compartment (either the tenancy or another of your compartments).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n\nTo determine which policies apply to a particular group or compartment, you must view the individual\nstatements inside all your policies. There isn't a way to automatically obtain that information via the API.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies: CreatePolicy",
|
|
"api_call": "POST /policies/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new policy in the specified compartment (either the tenancy or another of your compartments).\nIf you're new to policies, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n\nYou must specify a *name* for the policy, which must be unique across all policies in your tenancy\nand cannot be changed.\n\nYou must also specify a *description* for the policy (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdatePolicy](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Policy/UpdatePolicy).\n\nYou must specify one or more policy statements in the statements array. For information about writing\npolicies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm) and\n[Common Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/commonpolicies.htm).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n\nNew policies take effect typically within 10 seconds.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults > {tag Default Id}: DeleteTagDefault",
|
|
"api_call": "DELETE /tagDefaults/{tagDefaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagDefaultId": "[REQUIRED] string: (Required) The OCID of the tag default."
|
|
},
|
|
"functionality": "Deletes the the specified tag default.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults > {tag Default Id}: GetTagDefault",
|
|
"api_call": "GET /tagDefaults/{tagDefaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagDefaultId": "[REQUIRED] string: (Required) The OCID of the tag default."
|
|
},
|
|
"functionality": "Retrieves the specified tag default.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults > {tag Default Id}: UpdateTagDefault",
|
|
"api_call": "PUT /tagDefaults/{tagDefaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagDefaultId": "[REQUIRED] string: (Required) The OCID of the tag default."
|
|
},
|
|
"functionality": "Updates the specified tag default. If you specify that a value is required, a value is set\nduring resource creation (either by the user creating the resource or another tag defualt).\nIf no value is set, resource creation is blocked.\n\n* If the `isRequired` flag is set to \"true\", the value is set during resource creation.\n* If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults: ListTagDefaults",
|
|
"api_call": "GET /tagDefaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"compartmentId": "string: The OCID of the compartment (remember that the tenancy is simply the root compartment).\n"
|
|
},
|
|
"functionality": "Lists the tag defaults for tag definitions in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults: CreateTagDefault",
|
|
"api_call": "POST /tagDefaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new tag default in the specified compartment for the specified tag definition.\n\nIf you specify that a value is required, a value is set during resource creation (either by\nthe user creating the resource or another tag defualt). If no value is set, resource creation\nis blocked.\n\n* If the `isRequired` flag is set to \"true\", the value is set during resource creation.\n* If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults: AssembleEffectiveTagSet",
|
|
"api_call": "GET /tagDefaults/actions/assembleEffectiveTagSet",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n"
|
|
},
|
|
"functionality": "Assembles tag defaults in the specified compartment and any parent compartments to determine\nthe tags to apply. Tag defaults from parent compartments do not override tag defaults\nreferencing the same tag in a compartment lower down the hierarchy. This set of tag defaults\nincludes all tag defaults from the current compartment back to the root compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > actions: Delete tag namespace that contains tags",
|
|
"api_call": "POST /tagNamespaces/{tagNamespaceId}/actions/cascadeDelete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Deletes the specified tag namespace. This operation triggers a process that removes all of the tags\ndefined in the specified tag namespace from all resources in your tenancy and then deletes the tag namespace.\n\nAfter you start the delete operation:\n\n * New tag key definitions cannot be created under the namespace.\n * The state of the tag namespace changes to DELETING.\n * Tag removal from the resources begins.\n\nThis process can take up to 48 hours depending on the number of tag definitions in the namespace, the number of resources\nthat are tagged, and the locations of the regions in which those resources reside.\n\nAfter all tags are removed, the state changes to DELETED. You cannot restore a deleted tag namespace. After the deleted tag namespace\nchanges its state to DELETED, you can use the name of the deleted tag namespace again.\n\nAfter you start this operation, you cannot start either the [DeleteTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/DeleteTag) or the [BulkDeleteTags](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/BulkDeleteTags) operation until this process completes.\n\nTo delete a tag namespace, you must first retire it. Use [UpdateTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/UpdateTagNamespace)\nto retire a tag namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > actions: changes compartment of a tag namespace.",
|
|
"api_call": "POST /tagNamespaces/{tagNamespaceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Moves the specified tag namespace to the specified compartment within the same tenancy.\n\nTo move the tag namespace, you must have the manage tag-namespaces permission on both compartments.\nFor more information about IAM policies, see [Details for IAM](https://docs.oracle.com/iaas/Content/Identity/Reference/iampolicyreference.htm).\n\nMoving a tag namespace moves all the tag key definitions contained in the tag namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags > {tag Name}: DeleteTag",
|
|
"api_call": "DELETE /tagNamespaces/{tagNamespaceId}/tags/{tagName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n",
|
|
"tagName": "[REQUIRED] string: (Required) The name of the tag.\n"
|
|
},
|
|
"functionality": "Deletes the specified tag definition. This operation triggers a process that removes the\ntag from all resources in your tenancy.\n\nThese things happen immediately:\n\u00a0\n * If the tag was a cost-tracking tag, it no longer counts against your 10 cost-tracking\n tags limit, whether you first disabled it or not.\n * If the tag was used with dynamic groups, none of the rules that contain the tag will\n be evaluated against the tag.\n\nWhen you start the delete operation, the state of the tag changes to DELETING and tag removal\nfrom resources begins. This can take up to 48 hours depending on the number of resources that\nwere tagged as well as the regions in which those resources reside.\n\nWhen all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. Once the deleted tag\nchanges its state to DELETED, you can use the same tag name again.\n\nAfter you start this operation, you cannot start either the [BulkDeleteTags](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/BulkDeleteTags) or the [CascadeDeleteTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) operation until this process completes.\n\nTo delete a tag, you must first retire it. Use [UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/latest/Tag/UpdateTag)\nto retire a tag.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags > {tag Name}: GetTag",
|
|
"api_call": "GET /tagNamespaces/{tagNamespaceId}/tags/{tagName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n",
|
|
"tagName": "[REQUIRED] string: (Required) The name of the tag.\n"
|
|
},
|
|
"functionality": "Gets the specified tag's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags > {tag Name}: UpdateTag",
|
|
"api_call": "PUT /tagNamespaces/{tagNamespaceId}/tags/{tagName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n",
|
|
"tagName": "[REQUIRED] string: (Required) The name of the tag.\n"
|
|
},
|
|
"functionality": "Updates the specified tag definition.\n\nSetting `validator` determines the value type. Tags can use either a static value or a\nlist of possible values. Static values are entered by a user applying the tag to a resource.\nLists are created by you and the user must apply a value from the list. On update, any values\nin a list that were previously set do not change, but new values must pass validation. Values\nalready applied to a resource do not change.\n\nYou cannot remove list values that appear in a TagDefault. To remove a list value that\nappears in a TagDefault, first update the TagDefault to use a different value.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags: ListTags",
|
|
"api_call": "GET /tagNamespaces/{tagNamespaceId}/tags",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Lists the tag definitions in the specified tag namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags: CreateTag",
|
|
"api_call": "POST /tagNamespaces/{tagNamespaceId}/tags",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Creates a new tag in the specified tag namespace.\n\nThe tag requires either the OCID or the name of the tag namespace that will contain this\ntag definition.\n\nYou must specify a *name* for the tag, which must be unique across all tags in the tag namespace\nand cannot be changed. The name can contain any ASCII character except the space (_) or period (.) characters.\nNames are case insensitive. That means, for example, \"myTag\" and \"mytag\" are not allowed in the same namespace.\nIf you specify a name that's already in use in the tag namespace, a 409 error is returned.\n\nThe tag must have a *description*. It does not have to be unique, and you can change it with\n[UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/latest/Tag/UpdateTag).\n\nThe tag must have a value type, which is specified with a validator. Tags can use either a\nstatic value or a list of possible values. Static values are entered by a user applying the tag\nto a resource. Lists are created by you and the user must apply a value from the list. Lists\nare validiated.\n\n* If no `validator` is set, the user applying the tag to a resource can type in a static\nvalue or leave the tag value empty.\n* If a `validator` is set, the user applying the tag to a resource must select from a list\nof values that you supply with [EnumTagDefinitionValidator](https://docs.oracle.com/iaas/api/#/en/identity/latest/datatypes/EnumTagDefinitionValidator).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id}: DeleteTagNamespace",
|
|
"api_call": "DELETE /tagNamespaces/{tagNamespaceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Deletes the specified tag namespace. Only an empty tag namespace can be deleted with this operation. To use this operation\nto delete a tag namespace that contains tag definitions, first delete all of its tag definitions.\n\nUse [CascadeDeleteTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) to delete a tag namespace along with all of\nthe tag definitions contained within that namespace.\n\nUse [DeleteTag](https://docs.oracle.com/iaas/api/#/en/identity/latest/Tag/DeleteTag) to delete a tag definition.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id}: GetTagNamespace",
|
|
"api_call": "GET /tagNamespaces/{tagNamespaceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Gets the specified tag namespace's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id}: UpdateTagNamespace",
|
|
"api_call": "PUT /tagNamespaces/{tagNamespaceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Updates the the specified tag namespace. You can't update the namespace name.\n\nUpdating `isRetired` to 'true' retires the namespace and all the tag definitions in the namespace. Reactivating a\nnamespace (changing `isRetired` from 'true' to 'false') does not reactivate tag definitions.\nTo reactivate the tag definitions, you must reactivate each one individually *after* you reactivate the namespace,\nusing [UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/UpdateTag). For more information about retiring tag namespaces, see\n[Retiring Key Definitions and Namespace Definitions](https://docs.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#Retiring).\n\nYou can't add a namespace with the same name as a retired namespace in the same tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces: ListTagNamespaces",
|
|
"api_call": "GET /tagNamespaces",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"includeSubcompartments": "boolean: An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this\nparameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.\n"
|
|
},
|
|
"functionality": "Lists the tag namespaces in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces: CreateTagNamespace",
|
|
"api_call": "POST /tagNamespaces",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new tag namespace in the specified compartment.\n\nYou must specify the compartment ID in the request object (remember that the tenancy is simply the root\ncompartment).\n\nYou must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy\nand cannot be changed. The name can contain any ASCII character except the space (_) or period (.).\nNames are case insensitive. That means, for example, \"myNamespace\" and \"mynamespace\" are not allowed\nin the same tenancy. Once you created a namespace, you cannot change the name.\nIf you specify a name that's already in use in the tenancy, a 409 error is returned.\n\nYou must also specify a *description* for the namespace.\nIt does not have to be unique, and you can change it with\n[UpdateTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/latest/TagNamespace/UpdateTagNamespace).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces: ListCostTrackingTags",
|
|
"api_call": "GET /tagNamespaces/actions/listCostTrackingTags",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists all the tags enabled for cost-tracking in the specified tenancy. For information about\ncost-tracking tags, see [Using Cost-tracking Tags](https://docs.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#costs).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests > {work Request Id}: GetTaggingWorkRequest",
|
|
"api_call": "GET /taggingWorkRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header\nfor any asynchronous operation in the Identity and Access Management service.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests > {work Request Id}: ListTaggingWorkRequestErrors",
|
|
"api_call": "GET /taggingWorkRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets the errors for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests > {work Request Id}: ListTaggingWorkRequestLogs",
|
|
"api_call": "GET /taggingWorkRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets the logs for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests: ListTaggingWorkRequests",
|
|
"api_call": "GET /taggingWorkRequests/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the tagging work requests in compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tags > actions: Delete multiple tag key definitions at the same time",
|
|
"api_call": "POST /tags/actions/bulkDelete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Deletes the specified tag key definitions. This operation triggers a process that removes the\ntags from all resources in your tenancy. The tag key definitions must be within the same tag namespace.\n\nThe following actions happen immediately:\n\u00a0\n * If the tag is a cost-tracking tag, the tag no longer counts against your\n 10 cost-tracking tags limit, even if you do not disable the tag before running this operation.\n * If the tag is used with dynamic groups, the rules that contain the tag are no longer\n evaluated against the tag.\n\nAfter you start this operation, the state of the tag changes to DELETING, and tag removal\nfrom resources begins. This process can take up to 48 hours depending on the number of resources that\nare tagged and the regions in which those resources reside.\n\nWhen all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. After the tag state\nchanges to DELETED, you can use the same tag name again.\n\nAfter you start this operation, you cannot start either the [DeleteTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/DeleteTag) or the [CascadeDeleteTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) operation until this process completes.\n\nIn order to delete tags, you must first retire the tags. Use [UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/UpdateTag)\nto retire a tag.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tags > actions: Edit multiple tag key definitions on resources",
|
|
"api_call": "POST /tags/actions/bulkEdit",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Edits the specified list of tag key definitions for the selected resources. \nThis operation triggers a process that edits the tags on all selected resources. The possible actions are:\n\n * Add a defined tag when the tag does not already exist on the resource.\n * Update the value for a defined tag when the tag is present on the resource.\n * Add a defined tag when it does not already exist on the resource or update the value for a defined tag when the tag is present on the resource.\n * Remove a defined tag from a resource. The tag is removed from the resource regardless of the tag value.\n\nSee [BulkEditOperationDetails](https://docs.oracle.com/iaas/api/#/en/identity/latest/datatypes/BulkEditOperationDetails) for more information.\n\nThe edits can include a combination of operations and tag sets. \nHowever, multiple operations cannot apply to one key definition in the same request.\nFor example, if one request adds `tag set-1` to a resource and sets a tag value to `tag set-2`, \n`tag set-1` and `tag set-2` cannot have any common tag definitions.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tags: ListBulkEditTagsResourceTypes",
|
|
"api_call": "GET /tags/bulkEditResourceTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the resource types that support bulk tag editing.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tenancies/{tenancy Id} > region Subscriptions: ListRegionSubscriptions",
|
|
"api_call": "GET /tenancies/{tenancyId}/regionSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tenancyId": "[REQUIRED] string: (Required) The OCID of the tenancy."
|
|
},
|
|
"functionality": "Lists the region subscriptions for the specified tenancy.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tenancies/{tenancy Id} > region Subscriptions: CreateRegionSubscription",
|
|
"api_call": "POST /tenancies/{tenancyId}/regionSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tenancyId": "[REQUIRED] string: (Required) The OCID of the tenancy."
|
|
},
|
|
"functionality": "Creates a subscription to a region for a tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tenancies/{tenancy Id}: GetTenancy",
|
|
"api_call": "GET /tenancies/{tenancyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tenancyId": "[REQUIRED] string: (Required) The OCID of the tenancy."
|
|
},
|
|
"functionality": "Get the specified tenancy's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships > {user Group Membership Id}: RemoveUserFromGroup",
|
|
"api_call": "DELETE /userGroupMemberships/{userGroupMembershipId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userGroupMembershipId": "[REQUIRED] string: (Required) The OCID of the userGroupMembership."
|
|
},
|
|
"functionality": "Removes a user from a group by deleting the corresponding `UserGroupMembership`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships > {user Group Membership Id}: GetUserGroupMembership",
|
|
"api_call": "GET /userGroupMemberships/{userGroupMembershipId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userGroupMembershipId": "[REQUIRED] string: (Required) The OCID of the userGroupMembership."
|
|
},
|
|
"functionality": "Gets the specified UserGroupMembership's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships: ListUserGroupMemberships",
|
|
"api_call": "GET /userGroupMemberships/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"userId": "string: The OCID of the user.",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the `UserGroupMembership` objects in your tenancy. You must specify your tenancy's OCID\nas the value for the compartment ID\n(see [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five)).\nYou must also then filter the list in one of these ways:\n\n- You can limit the results to just the memberships for a given user by specifying a `userId`.\n- Similarly, you can limit the results to just the memberships for a given group by specifying a `groupId`.\n- You can set both the `userId` and `groupId` to determine if the specified user is in the specified group.\nIf the answer is no, the response is an empty list.\n- Although`userId` and `groupId` are not individually required, you must set one of them.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships: AddUserToGroup",
|
|
"api_call": "POST /userGroupMemberships/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > api Keys: ListApiKeys",
|
|
"api_call": "GET /users/{userId}/apiKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the API signing keys for the specified user. A user can have a maximum of three keys.\n\nEvery user has permission to use this API call for *their own user ID*. An administrator in your\norganization does not need to write a policy to give users this ability.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > api Keys: UploadApiKey",
|
|
"api_call": "POST /users/{userId}/apiKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Uploads an API signing key for the specified user.\n\nEvery user has permission to use this operation to upload a key for *their own user ID*. An\nadministrator in your organization does not need to write a policy to give users this ability.\nTo compare, administrators who have permission to the tenancy can use this operation to upload a\nkey for any user, including themselves.\n\n**Important:** Even though you have permission to upload an API key, you might not yet\nhave permission to do much else. If you try calling an operation unrelated to your own credential\nmanagement (e.g., `ListUsers`, `LaunchInstance`) and receive an \"unauthorized\" error,\ncheck with an administrator to confirm which IAM Service group(s) you're in and what access\nyou have. Also confirm you're working in the correct compartment.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using\nthe object, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > api Keys: DeleteApiKey",
|
|
"api_call": "DELETE /users/{userId}/apiKeys/{fingerprint}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"fingerprint": "[REQUIRED] string: (Required) The key's fingerprint."
|
|
},
|
|
"functionality": "Deletes the specified API signing key for the specified user.\n\nEvery user has permission to use this operation to delete a key for *their own user ID*. An\nadministrator in your organization does not need to write a policy to give users this ability.\nTo compare, administrators who have permission to the tenancy can use this operation to delete\na key for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens > {auth Token Id}: DeleteAuthToken",
|
|
"api_call": "DELETE /users/{userId}/authTokens/{authTokenId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"authTokenId": "[REQUIRED] string: (Required) The OCID of the auth token."
|
|
},
|
|
"functionality": "Deletes the specified auth token for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens > {auth Token Id}: UpdateAuthToken",
|
|
"api_call": "PUT /users/{userId}/authTokens/{authTokenId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"authTokenId": "[REQUIRED] string: (Required) The OCID of the auth token."
|
|
},
|
|
"functionality": "Updates the specified auth token's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens: ListAuthTokens",
|
|
"api_call": "GET /users/{userId}/authTokens/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not\nthe token itself. The actual token is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens: CreateAuthToken",
|
|
"api_call": "POST /users/{userId}/authTokens/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new auth token for the specified user. For information about what auth tokens are for, see\n[Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the auth token (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/UpdateAuthToken).\n\nEvery user has permission to create an auth token for *their own user ID*. An administrator in your organization\ndoes not need to write a policy to give users this ability. To compare, administrators who have permission to the\ntenancy can use this operation to create an auth token for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys > {customer Secret Key Id}: DeleteCustomerSecretKey",
|
|
"api_call": "DELETE /users/{userId}/customerSecretKeys/{customerSecretKeyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"customerSecretKeyId": "[REQUIRED] string: (Required) The OCID of the secret key."
|
|
},
|
|
"functionality": "Deletes the specified secret key for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys > {customer Secret Key Id}: UpdateCustomerSecretKey",
|
|
"api_call": "PUT /users/{userId}/customerSecretKeys/{customerSecretKeyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"customerSecretKeyId": "[REQUIRED] string: (Required) The OCID of the secret key."
|
|
},
|
|
"functionality": "Updates the specified secret key's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys: ListCustomerSecretKeys",
|
|
"api_call": "GET /users/{userId}/customerSecretKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not\nthe secret key itself. The actual secret key is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys: CreateCustomerSecretKey",
|
|
"api_call": "POST /users/{userId}/customerSecretKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service's Amazon S3\ncompatible API. The secret key consists of an Access Key/Secret Key pair. For information, see\n[Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the secret key (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateCustomerSecretKey](https://docs.oracle.com/iaas/api/#/en/identity/20160918/CustomerSecretKeySummary/UpdateCustomerSecretKey).\n\nEvery user has permission to create a secret key for *their own user ID*. An administrator in your organization\ndoes not need to write a policy to give users this ability. To compare, administrators who have permission to the\ntenancy can use this operation to create a secret key for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id} > actions: ActivateMfaTotpDevice",
|
|
"api_call": "POST /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id} > actions: GenerateTotpSeed",
|
|
"api_call": "POST /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/generateSeed",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Generate seed for the MFA TOTP device.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id}: DeleteMfaTotpDevice",
|
|
"api_call": "DELETE /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Deletes the specified MFA TOTP device for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id}: GetMfaTotpDevice",
|
|
"api_call": "GET /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Get the specified MFA TOTP device for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices: ListMfaTotpDevices",
|
|
"api_call": "GET /users/{userId}/mfaTotpDevices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the MFA TOTP devices for the specified user. The returned object contains the device's OCID, but not\nthe seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices: CreateMfaTotpDevice",
|
|
"api_call": "POST /users/{userId}/mfaTotpDevices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials > {oauth2Client Credential Id}: Delete Oauth token for the user",
|
|
"api_call": "DELETE /users/{userId}/oauth2ClientCredentials/{oauth2ClientCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"oauth2ClientCredentialId": "[REQUIRED] string: (Required) The ID of the Oauth credential."
|
|
},
|
|
"functionality": "Delete Oauth token for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials > {oauth2Client Credential Id}: Updates Oauth token for the user",
|
|
"api_call": "PUT /users/{userId}/oauth2ClientCredentials/{oauth2ClientCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"oauth2ClientCredentialId": "[REQUIRED] string: (Required) The ID of the Oauth credential."
|
|
},
|
|
"functionality": "Updates Oauth token for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials: List of Oauth tokens for the user",
|
|
"api_call": "GET /users/{userId}/oauth2ClientCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "List of Oauth tokens for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials: Creates Oauth token for the user",
|
|
"api_call": "POST /users/{userId}/oauth2ClientCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates Oauth token for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials > {smtp Credential Id}: DeleteSmtpCredential",
|
|
"api_call": "DELETE /users/{userId}/smtpCredentials/{smtpCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"smtpCredentialId": "[REQUIRED] string: (Required) The OCID of the SMTP credential."
|
|
},
|
|
"functionality": "Deletes the specified SMTP credential for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials > {smtp Credential Id}: UpdateSmtpCredential",
|
|
"api_call": "PUT /users/{userId}/smtpCredentials/{smtpCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"smtpCredentialId": "[REQUIRED] string: (Required) The OCID of the SMTP credential."
|
|
},
|
|
"functionality": "Updates the specified SMTP credential's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials: ListSmtpCredentials",
|
|
"api_call": "GET /users/{userId}/smtpCredentials/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID,\nthe SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials: CreateSmtpCredential",
|
|
"api_call": "POST /users/{userId}/smtpCredentials/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new SMTP credential for the specified user. An SMTP credential has an SMTP user name and an SMTP password.\nYou must specify a *description* for the SMTP credential (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateSmtpCredential](https://docs.oracle.com/iaas/api/#/en/identity/20160918/SmtpCredentialSummary/UpdateSmtpCredential).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords > {swift Password Id}: DeleteSwiftPassword",
|
|
"api_call": "DELETE /users/{userId}/swiftPasswords/{swiftPasswordId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"swiftPasswordId": "[REQUIRED] string: (Required) The OCID of the Swift password."
|
|
},
|
|
"functionality": "**Deprecated. Use [DeleteAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/DeleteAuthToken) instead.**\n\nDeletes the specified Swift password for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords > {swift Password Id}: UpdateSwiftPassword",
|
|
"api_call": "PUT /users/{userId}/swiftPasswords/{swiftPasswordId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"swiftPasswordId": "[REQUIRED] string: (Required) The OCID of the Swift password."
|
|
},
|
|
"functionality": "**Deprecated. Use [UpdateAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/UpdateAuthToken) instead.**\n\nUpdates the specified Swift password's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords: ListSwiftPasswords",
|
|
"api_call": "GET /users/{userId}/swiftPasswords/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "**Deprecated. Use [ListAuthTokens](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/ListAuthTokens) instead.**\n\nLists the Swift passwords for the specified user. The returned object contains the password's OCID, but not\nthe password itself. The actual password is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords: CreateSwiftPassword",
|
|
"api_call": "POST /users/{userId}/swiftPasswords/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "**Deprecated. Use [CreateAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/CreateAuthToken) instead.**\n\nCreates a new Swift password for the specified user. For information about what Swift passwords are for, see\n[Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the Swift password (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateSwiftPassword](https://docs.oracle.com/iaas/api/#/en/identity/20160918/SwiftPassword/UpdateSwiftPassword).\n\nEvery user has permission to create a Swift password for *their own user ID*. An administrator in your organization\ndoes not need to write a policy to give users this ability. To compare, administrators who have permission to the\ntenancy can use this operation to create a Swift password for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: DeleteUser",
|
|
"api_call": "DELETE /users/{userId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Deletes the specified user. The user must not be in any groups.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: GetUser",
|
|
"api_call": "GET /users/{userId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Gets the specified user's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: UpdateUser",
|
|
"api_call": "PUT /users/{userId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Updates the description of the specified user.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: UpdateUserCapabilities",
|
|
"api_call": "PUT /users/{userId}/capabilities/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Updates the capabilities of the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: UpdateUserState",
|
|
"api_call": "PUT /users/{userId}/state/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Updates the state of the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: CreateOrResetUIPassword",
|
|
"api_call": "POST /users/{userId}/uiPassword",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new Console one-time password for the specified user. For more information about user\ncredentials, see [User Credentials](https://docs.oracle.com/iaas/Content/Identity/Concepts/usercredentials.htm).\n\nUse this operation after creating a new user, or if a user forgets their password. The new one-time\npassword is returned to you in the response, and you must securely deliver it to the user. They'll\nbe prompted to change this password the next time they sign in to the Console. If they don't change\nit within 7 days, the password will expire and you'll need to create a new one-time password for the\nuser.\n\n**Note:** The user's Console login is the unique name you specified when you created the user\n(see [CreateUser](https://docs.oracle.com/iaas/api/#/en/identity/20160918/User/CreateUser)).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users: ListUsers",
|
|
"api_call": "GET /users/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the users in your tenancy. You must specify your tenancy's OCID as the value for the\ncompartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users: CreateUser",
|
|
"api_call": "POST /users/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other\nIAM Service components, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the\ntenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and\nsome policies) reside within the tenancy itself, unlike cloud resources such as compute instances,\nwhich typically reside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the user, which must be unique across all users in your tenancy\nand cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods,\nunderscores, +, and @. If you specify a name that's already in use, you'll get a 409 error.\nThis name will be the user's login to the Console. You might want to pick a\nname that your company's own identity system (e.g., Active Directory, LDAP, etc.) already uses.\nIf you delete a user and then create a new user with the same name, they'll be considered different\nusers because they have different OCIDs.\n\nYou must also specify a *description* for the user (although it can be an empty string).\nIt does not have to be unique, and you can change it anytime with\n[UpdateUser](https://docs.oracle.com/iaas/api/#/en/identity/20160918/User/UpdateUser). You can use the field to provide the user's\nfull name, a description, a nickname, or other information to generally identify the user.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before\nusing the object, first make sure its `lifecycleState` has changed to ACTIVE.\n\nA new user has no permissions until you place the user in one or more groups (see\n[AddUserToGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UserGroupMembership/AddUserToGroup)). If the user needs to\naccess the Console, you need to provide the user a password (see\n[CreateOrResetUIPassword](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UIPassword/CreateOrResetUIPassword)).\nIf the user needs to access the Oracle Cloud Infrastructure REST API, you need to upload a\npublic API signing key for that user (see\n[Required Keys and OCIDs](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm) and also\n[UploadApiKey](https://docs.oracle.com/iaas/api/#/en/identity/20160918/ApiKey/UploadApiKey)).\n\n**Important:** Make sure to inform the new user which compartment(s) they have access to.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - work Requests: ListWorkRequests",
|
|
"api_call": "GET /workRequests/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the work requests in compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - work Requests: GetWorkRequest",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header\nfor any asynchronous operation in the Identity and Access Management service.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - General: ListAvailabilityDomains",
|
|
"api_call": "GET /availabilityDomains/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n"
|
|
},
|
|
"functionality": "Lists the availability domains in your tenancy. Specify the OCID of either the tenancy or another\nof your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\nNote that the order of the results returned can change if availability domains are added or removed; therefore, do not\ncreate a dependency on the list order.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - General: ListFaultDomains",
|
|
"api_call": "GET /faultDomains/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"availabilityDomain": "string: (Required) The name of the availibilityDomain.\n"
|
|
},
|
|
"functionality": "Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another\nof your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - General: ListRegions",
|
|
"api_call": "GET /regions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header"
|
|
},
|
|
"functionality": "Lists all the regions offered by Oracle Cloud Infrastructure.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect dominant language over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectDominantLanguage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API returns the detected language and a related confidence score (between 0 and 1). It supports passing a batch of records.\n\n[List of supported languages.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch Detect entities over pre-deployed model",
|
|
"api_call": "POST /actions/batchDetectLanguageEntities",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts entities in text records. For each entity, its type/subtype and confidence score (between 0 and 1) is returned. It supports passing a batch of records.\n\n[List of supported entities.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#ner__sup-ner-entity)\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect keyPhrase over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectLanguageKeyPhrases",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text. It supports passing a batch of records.\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect sentiments over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectLanguageSentiments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"level": "string: Set this parameter for sentence and aspect level sentiment analysis.\nAllowed values are:\n - ASPECT\n - SENTENCE\n"
|
|
},
|
|
"functionality": "The API extracts aspect-based and sentence level sentiment in text records.\n\nFor aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned for each record. Similarly, for sentence-level sentiment analysis, the sentiment is returned at the sentence level.\n\nFor sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral and mixed).\n\nLearn more about sentiment analysis [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment).\n\nLimitations:\n - A batch may have up to 100 records.\n - A record may be up to 5000 characters long.\n - The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect text classification over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectLanguageTextClassification",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.\n\nIt supports passing a batch of records.\n\nLearn more about text classification [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class).\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect dominant language over pre-deployed model.",
|
|
"api_call": "POST /actions/detectDominantLanguage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API returns the detected language and a related confidence score (between 0 and 1).\n\n[List of supported languages.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)\n\nLimitations:\n- A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect entities over pre-deployed model",
|
|
"api_call": "POST /actions/detectLanguageEntities",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelVersion": "number: Named Entity Recognition model versions. By default user will get output from V2.1 implementation.",
|
|
"isPii": "boolean: If this parameter is set to true, you only get PII (Personally identifiable information) entities\nlike PhoneNumber, Email, Person, and so on. Default value is false.\n"
|
|
},
|
|
"functionality": "The API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned.\n\nLimitations:\n- A text may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect keyPhrase over pre-deployed model.",
|
|
"api_call": "POST /actions/detectLanguageKeyPhrases",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text.\n\nLimitations:\n- A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect sentiments over pre-deployed model.",
|
|
"api_call": "POST /actions/detectLanguageSentiments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts aspect-based in text records.\n\nFor aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned.\n\nFor sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral).\n\nLearn more about sentiment analysis [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment).\n\nLimitations:\n - A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect text classification over pre-deployed model.",
|
|
"api_call": "POST /actions/detectLanguageTextClassification",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.\n\nLearn more about text classification [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class).\n\nLimitations:\n- A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Logging Search API - General: Search logs.",
|
|
"api_call": "POST /search",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return in a response.\n"
|
|
},
|
|
"functionality": "Submit a query to search logs.\n\nSee [Using the API](https://docs.oracle.com/iaas/Content/Logging/Concepts/using_the_api_searchlogs.htm) for SDK examples.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements > {acceptedAgreementId}: Removes an accepted terms of use agreement.",
|
|
"api_call": "DELETE /acceptedAgreements/{acceptedAgreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"signature": "string: Previously, the signature generated for the listing package terms of use agreement, but now deprecated and ignored.",
|
|
"acceptedAgreementId": "[REQUIRED] string: (Required) The unique identifier for the accepted terms of use agreement."
|
|
},
|
|
"functionality": "Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks\nbefore initiating a deployment. Listings in Marketplace that require acceptance of the specified terms\nof use can no longer be deployed, but existing deployments aren't affected.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements > {acceptedAgreementId}: Gets the details of a terms of use agreement.",
|
|
"api_call": "GET /acceptedAgreements/{acceptedAgreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"acceptedAgreementId": "[REQUIRED] string: (Required) The unique identifier for the accepted terms of use agreement."
|
|
},
|
|
"functionality": "Gets the details of a specific, previously accepted terms of use agreement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements > {acceptedAgreementId}: Updates an accepted terms of use agreement.",
|
|
"api_call": "PUT /acceptedAgreements/{acceptedAgreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"acceptedAgreementId": "[REQUIRED] string: (Required) The unique identifier for the accepted terms of use agreement."
|
|
},
|
|
"functionality": "Updates the display name or tags associated with a listing's previously accepted terms of use agreement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements: Gets the list of accepted terms of use agreements in the specified compartment.",
|
|
"api_call": "GET /acceptedAgreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"displayName": "string: The display name of the resource.",
|
|
"listingId": "string: The unique identifier for the listing.",
|
|
"packageVersion": "string: The version of the package. Package versions are unique within a listing.",
|
|
"acceptedAgreementId": "string: The unique identifier for the accepted terms of use agreement.",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMEACCEPTED` displays results in descending order by default. You can change your\npreference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call."
|
|
},
|
|
"functionality": "Lists the terms of use agreements that have been accepted in the specified compartment.\nYou can filter results by specifying query parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements: Accepts a terms of use agreement for a listing.",
|
|
"api_call": "POST /acceptedAgreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Accepts a terms of use agreement for a specific package version of a listing. You must accept all\nterms of use for a package before you can deploy the package.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages > {packageVersion} > agreements: Lists terms of use agreements for a package.",
|
|
"api_call": "GET /listings/{listingId}/packages/{packageVersion}/agreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing."
|
|
},
|
|
"functionality": "Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages > {packageVersion} > agreements: Gets a terms of use agreement for a package.",
|
|
"api_call": "GET /listings/{listingId}/packages/{packageVersion}/agreements/{agreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing.",
|
|
"agreementId": "[REQUIRED] string: (Required) The unique identifier for the agreement."
|
|
},
|
|
"functionality": "Returns a terms of use agreement for a package with a time-based signature that can be used to\naccept the agreement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages > {packageVersion}: Get the details of a specific package version.",
|
|
"api_call": "GET /listings/{listingId}/packages/{packageVersion}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing."
|
|
},
|
|
"functionality": "Get the details of the specified version of a package, including information needed to launch the package.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages: Gets the list of packages for a listing.",
|
|
"api_call": "GET /listings/{listingId}/packages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"packageVersion": "string: The version of the package. Package versions are unique within a listing.",
|
|
"packageType": "string: A filter to return only packages that match the given package type exactly.\n",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing."
|
|
},
|
|
"functionality": "Gets the list of packages for a listing.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId}: Gets the details of a listing.",
|
|
"api_call": "GET /listings/{listingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing."
|
|
},
|
|
"functionality": "Gets detailed information about a listing, including the listing's name, version, description, and\nresources.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId}: Gets tax implication that current tenant may be eligible while using specific listing.",
|
|
"api_call": "GET /listings/{listingId}/taxes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing."
|
|
},
|
|
"functionality": "Returns list of all tax implications that current tenant may be liable to once they launch the listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings: Gets a list of listings.",
|
|
"api_call": "GET /listings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"pricing": "string: Name of the pricing type. If multiple pricing types are provided, then any listing with\none or more matching pricing models will be returned.\n",
|
|
"listingTypes": "string: The type of the listing.",
|
|
"compartmentId": "string: The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and\nfiltering according to listing attributes.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId} > packages: Lists the packages in a publication.",
|
|
"api_call": "GET /publications/{publicationId}/packages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"packageVersion": "string: The version of the package. Package versions are unique within a listing.",
|
|
"packageType": "string: A filter to return only packages that match the given package type exactly.\n",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Lists the packages in the specified publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId} > packages: Gets a package version of a specified publication.",
|
|
"api_call": "GET /publications/{publicationId}/packages/{packageVersion}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing."
|
|
},
|
|
"functionality": "Gets the details of a specific package version within a given publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Deletes a publication.",
|
|
"api_call": "DELETE /publications/{publicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Deletes a publication, which also removes the associated listing from anywhere it was published, such as Marketplace or Compute.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Gets a publication.",
|
|
"api_call": "GET /publications/{publicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Gets the details of the specified publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Updates an existing publication.",
|
|
"api_call": "PUT /publications/{publicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Updates the details of an existing publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Changes the compartment of the publication.",
|
|
"api_call": "POST /publications/{publicationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Moves the specified publication from one compartment to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications: Lists all publications.",
|
|
"api_call": "GET /publications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"listingType": "string: (Required) The type of the listing.",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n"
|
|
},
|
|
"functionality": "Lists the publications in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications: Creates a publication.",
|
|
"api_call": "POST /publications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a publication of the specified listing type with an optional default package.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Gets a list of listing categories.",
|
|
"api_call": "GET /categories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"compartmentId": "string: The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace. Categories apply\nto the software product provided by the listing.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Get Tenant eligibility and other information for launching a PIC image",
|
|
"api_call": "GET /launchEligibility",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"imageId": "string: (Required) Image ID"
|
|
},
|
|
"functionality": "Returns Tenant eligibility and other information for launching a PIC image",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Gets a list of publishers.",
|
|
"api_call": "GET /publishers",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"compartmentId": "string: The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Lists available reports.",
|
|
"api_call": "GET /reportTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call."
|
|
},
|
|
"functionality": "Lists available types of reports for the compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Lists reports.",
|
|
"api_call": "GET /reports",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"reportType": "string: (Required) The type of the report.",
|
|
"date": "number: (Required) Date, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The service only interprets the year, month, and day parts in the input value, and ignores the hour, minute, and second parts.\n",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Lists reports in the compartment that match the specified report type and date.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Finds Marketplace listings",
|
|
"api_call": "POST /searchListings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n"
|
|
},
|
|
"functionality": "Queries all Marketplace Applications to find listings that match the specified criteria. To search \nfor a listing, you can use a free text or structured search.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Get eligibilty of the tenancy to see third party paid listings",
|
|
"api_call": "GET /thirdPartyPaidListingEligibility",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Returns eligibility details of the tenancy to see and launch third party paid listings",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id} > distribution Channel Attachments > {distribution Channel Id}: Deletes a MediaAsset from DistributionChannel.",
|
|
"api_call": "DELETE /mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"version": "integer: Version of the attachment.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier",
|
|
"distributionChannelId": "[REQUIRED] string: (Required) Unique DistributionChannel identifier."
|
|
},
|
|
"functionality": "Deletes a MediaAsset from the DistributionChannel by identifiers.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id} > distribution Channel Attachments > {distribution Channel Id}: Get a MediaAssetDistributionChannelAttachment for a MediaAsset.",
|
|
"api_call": "GET /mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"version": "integer: Version of the attachment.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier",
|
|
"distributionChannelId": "[REQUIRED] string: (Required) Unique DistributionChannel identifier."
|
|
},
|
|
"functionality": "Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id} > distribution Channel Attachments: List MediaAssetDistributionChannelAttachments for MediaAsset.",
|
|
"api_call": "GET /mediaAssets/{mediaAssetId}/distributionChannelAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"displayName": "string: A filter to return only the resources that match the entire display name given.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Delete a provisioned MediaAsset",
|
|
"api_call": "DELETE /mediaAssets/{mediaAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"deleteMode": "string: DeleteMode decides whether to delete all the immediate children or all assets with the asset's ID as their masterMediaAssetId.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Deletes a MediaAsset resource by identifier. If DeleteChildren is passed in as the mode, all the assets with the parentMediaAssetId matching the ID will be deleted. If DeleteDerivatives is set as the mode, all the assets with the masterMediaAssetId matching the ID will be deleted.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Get MediaAsset",
|
|
"api_call": "GET /mediaAssets/{mediaAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Gets a MediaAsset by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Update the MediaAsset identified by the ID.",
|
|
"api_call": "PUT /mediaAssets/{mediaAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Updates the MediaAsset.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Moves an asset into a different compartment.",
|
|
"api_call": "POST /mediaAssets/{mediaAssetId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Moves a MediaAsset resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets: Gets a list of all MediaAssetSummary in a compartment.",
|
|
"api_call": "GET /mediaAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Returns a list of MediaAssetSummary.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets: Creates a new MediaAsset",
|
|
"api_call": "POST /mediaAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new MediaAsset.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Deletes a provisioned MediaWorkflowConfiguration.",
|
|
"api_call": "DELETE /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Deletes a MediaWorkflowConfiguration resource by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Get MediaWorkflowConfiguration",
|
|
"api_call": "GET /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Gets a MediaWorkflowConfiguration by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Update the MediaWorkflowConfiguration identified by the ID.",
|
|
"api_call": "PUT /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Updates the MediaWorkflowConfiguration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Moves a MediaWorkflowConfiguration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations: Gets a list of all MediaWorkflowConfigurations in a compartment.",
|
|
"api_call": "GET /mediaWorkflowConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Returns a list of MediaWorkflowConfigurations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations: Creates a new MediaWorkflowConfiguration.",
|
|
"api_call": "POST /mediaWorkflowConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new MediaWorkflowConfiguration.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id} > facts: List MediaWorkflowJobFacts",
|
|
"api_call": "GET /mediaWorkflowJobs/{mediaWorkflowJobId}/facts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Internal API to get a point-in-time snapshot of a MediaWorkflowJob.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id} > facts: Get a MediaWorkflowJobFact",
|
|
"api_call": "GET /mediaWorkflowJobs/{mediaWorkflowJobId}/facts/{key}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier.",
|
|
"key": "[REQUIRED] integer: (Required) Identifier of the MediaWorkflowJobFact within a MediaWorkflowJob."
|
|
},
|
|
"functionality": "Get the MediaWorkflowJobFact identified by the mediaWorkflowJobId and Fact ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Cancel a MediaWorkflowJob identified by the mediaWorkflowJobId",
|
|
"api_call": "DELETE /mediaWorkflowJobs/{mediaWorkflowJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "This is an asynchronous operation. The MediaWorkflowJob lifecycleState will change to CANCELING temporarily until the job is completely CANCELED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Get MediaWorkflowJob identified by the mediaWorkflowId and jobId",
|
|
"api_call": "GET /mediaWorkflowJobs/{mediaWorkflowJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Gets the MediaWorkflowJob.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Update the MediaWorkflowJob identified by the id",
|
|
"api_call": "PUT /mediaWorkflowJobs/{mediaWorkflowJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Updates the MediaWorkflowJob.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /mediaWorkflowJobs/{mediaWorkflowJobId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Moves a MediaWorkflowJob resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs: List MediaWorkflowJobs in a compartment",
|
|
"api_call": "GET /mediaWorkflowJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"sortBy": "string: The parameter sort by.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'."
|
|
},
|
|
"functionality": "Lists the MediaWorkflowJobs.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs: Creates and runs a MediaWorkflowJob for the the MediaWorkflow identified by mediaWorkflowId",
|
|
"api_call": "POST /mediaWorkflowJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Run the MediaWorkflow according to the given mediaWorkflow definition and configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Deletes a MediaWorkflow identified by the mediaWorkflowId.",
|
|
"api_call": "DELETE /mediaWorkflows/{mediaWorkflowId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "The MediaWorkflow lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Gets MediaWorkflow.",
|
|
"api_call": "GET /mediaWorkflows/{mediaWorkflowId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "Gets a MediaWorkflow by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Updates the MediaWorkflow identified by the ID.",
|
|
"api_call": "PUT /mediaWorkflows/{mediaWorkflowId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "Updates the MediaWorkflow.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /mediaWorkflows/{mediaWorkflowId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "Moves a MediaWorkflow resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows: Lists the MediaWorkflows.",
|
|
"api_call": "GET /mediaWorkflows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the MediaWorkflows.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows: Creates a new MediaWorkflow.",
|
|
"api_call": "POST /mediaWorkflows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new MediaWorkflow.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs > {stream Cdn Config Id}: Deletes a StreamCdnConfig identified by the streamCdnConfigId.",
|
|
"api_call": "DELETE /streamCdnConfigs/{streamCdnConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"streamCdnConfigId": "[REQUIRED] string: (Required) Unique StreamCdnConfig identifier."
|
|
},
|
|
"functionality": "The StreamCdnConfig lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs > {stream Cdn Config Id}: Gets StreamCdnConfig.",
|
|
"api_call": "GET /streamCdnConfigs/{streamCdnConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"streamCdnConfigId": "[REQUIRED] string: (Required) Unique StreamCdnConfig identifier."
|
|
},
|
|
"functionality": "Gets a StreamCdnConfig by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs > {stream Cdn Config Id}: Updates the StreamCdnConfig identified by the ID.",
|
|
"api_call": "PUT /streamCdnConfigs/{streamCdnConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamCdnConfigId": "[REQUIRED] string: (Required) Unique StreamCdnConfig identifier."
|
|
},
|
|
"functionality": "Updates the StreamCdnConfig.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs: Lists the StreamCdnConfig.",
|
|
"api_call": "GET /streamCdnConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"distributionChannelId": "string: (Required) The Stream Distribution Channel identifier this CdnConfig belongs to.\n"
|
|
},
|
|
"functionality": "Lists the StreamCdnConfig.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs: Creates a new CDN Configuration.",
|
|
"api_call": "POST /streamCdnConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new CDN Configuration.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id} > actions: Moves a resource into a different compartment.",
|
|
"api_call": "POST /streamDistributionChannels/{streamDistributionChannelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Moves a Stream Distribution Channel resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id} > actions: Ingests an Asset into a Distribution Channel.",
|
|
"api_call": "POST /streamDistributionChannels/{streamDistributionChannelId}/actions/ingest",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Ingests an Asset into a Distribution Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id}: Deletes a Stream Distribution Channel identified by the streamDistributionChannelId.",
|
|
"api_call": "DELETE /streamDistributionChannels/{streamDistributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "The Stream Distribution Channel lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id}: Gets a Stream Distribution Channel.",
|
|
"api_call": "GET /streamDistributionChannels/{streamDistributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Gets a Stream Distribution Channel by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id}: Update the Stream Distribution Channel identified by the id",
|
|
"api_call": "PUT /streamDistributionChannels/{streamDistributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Updates the Stream Distribution Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels: Lists Stream Distribution Channels.",
|
|
"api_call": "GET /streamDistributionChannels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the Stream Distribution Channels.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels: Creates a new Stream Distribution Channel",
|
|
"api_call": "POST /streamDistributionChannels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new Stream Distribution Channel.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs > {stream Packaging Config Id}: Deletes a Stream Packaging Configuration identified by the streamPackagingConfigId.",
|
|
"api_call": "DELETE /streamPackagingConfigs/{streamPackagingConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"streamPackagingConfigId": "[REQUIRED] string: (Required) Unique Stream Packaging Configuration path identifier."
|
|
},
|
|
"functionality": "The Stream Packaging Configuration lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs > {stream Packaging Config Id}: Get a Stream Packaging Configuration.",
|
|
"api_call": "GET /streamPackagingConfigs/{streamPackagingConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"streamPackagingConfigId": "[REQUIRED] string: (Required) Unique Stream Packaging Configuration path identifier."
|
|
},
|
|
"functionality": "Gets a Stream Packaging Configuration by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs > {stream Packaging Config Id}: Updates the Stream Packaging Configuration identified by the ID.",
|
|
"api_call": "PUT /streamPackagingConfigs/{streamPackagingConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamPackagingConfigId": "[REQUIRED] string: (Required) Unique Stream Packaging Configuration path identifier."
|
|
},
|
|
"functionality": "Updates the Stream Packaging Configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs: List Stream Packaging Configurations",
|
|
"api_call": "GET /streamPackagingConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"distributionChannelId": "string: (Required) Unique Stream Distribution Channel identifier."
|
|
},
|
|
"functionality": "Lists the Stream Packaging Configurations.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs: Creates a new Stream Packaging Configuration.",
|
|
"api_call": "POST /streamPackagingConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new Packaging Configuration.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - General: Gets a list of all MediaWorkflowTaskDeclarations.",
|
|
"api_call": "GET /mediaWorkflowTaskDeclarations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'."
|
|
},
|
|
"functionality": "Returns a list of MediaWorkflowTaskDeclarations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - General: Lists SystemMediaWorkflows.",
|
|
"api_call": "GET /systemMediaWorkflows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id} > actions: Change Alarm Compartment",
|
|
"api_call": "POST /alarms/{alarmId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Moves an alarm into a different compartment within the same tenancy.\n\nFor information about moving resources between compartments, see [Moving Resources Between Compartments](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id} > actions: Removes any existing suppression for the specified alarm.\n",
|
|
"api_call": "POST /alarms/{alarmId}/actions/removeSuppression",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Removes any existing suppression for the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Get Alarm",
|
|
"api_call": "GET /alarms/{alarmId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Gets the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Updates an alarm.\n",
|
|
"api_call": "PUT /alarms/{alarmId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Updates the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Deletes an alarm.\n",
|
|
"api_call": "DELETE /alarms/{alarmId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Deletes the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Get Alarm History",
|
|
"api_call": "GET /alarms/{alarmId}/history",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"alarmHistorytype": "string: The type of history entries to retrieve. State history (STATE_HISTORY) or state transition history (STATE_TRANSITION_HISTORY).\nIf not specified, entries of both types are retrieved.\n\nExample: `STATE_HISTORY`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"timestampGreaterThanOrEqualTo": "number: A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.\n\nExample: `2019-01-01T01:00:00.789Z`\n",
|
|
"timestampLessThan": "number: A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.\n\nExample: `2019-01-02T01:00:00.789Z`\n",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Get the history of the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms: List Alarms",
|
|
"api_call": "GET /alarms",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.\n",
|
|
"lifecycleState": "string: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.\n",
|
|
"sortBy": "string: The field to use when sorting returned alarm definitions. Only one sorting level is provided.\n\nExample: `severity`\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
|
|
},
|
|
"functionality": "Lists the alarms for the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms: Creates a new alarm in the specified compartment.\n",
|
|
"api_call": "POST /alarms",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new alarm in the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms: List Alarms Status",
|
|
"api_call": "GET /alarms/status",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"sortBy": "string: The field to use when sorting returned alarm definitions. Only one sorting level is provided.\n\nExample: `severity`\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\n"
|
|
},
|
|
"functionality": "List the status of each alarm in the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - metrics > actions: List metrics based on matching criteria.",
|
|
"api_call": "POST /metrics/actions/listMetrics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
|
|
},
|
|
"functionality": "Returns metric definitions that match the criteria specified in the request. Compartment OCID required.\nFor information about metrics, see [Metrics Overview](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nTransactions Per Second (TPS) per-tenancy limit for this operation: 10.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - metrics > actions: Summarizes and returns metrics data filtered using the provided query expression and compartmentId.",
|
|
"api_call": "POST /metrics/actions/summarizeMetricsData",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
|
|
},
|
|
"functionality": "Returns aggregated data that match the criteria specified in the request. Compartment OCID required.\nFor information on metric queries, see [Building Metric Queries](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/buildingqueries.htm).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nTransactions Per Second (TPS) per-tenancy limit for this operation: 10.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - metrics: Publishes raw metric data points to the Monitoring service.\n",
|
|
"api_call": "POST /metrics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Publishes raw metric data points to the Monitoring service.\nFor more information about publishing metrics, see [Publishing Custom Metrics](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nPer-call limits information follows.\n\n* Dimensions per metric group*. Maximum: 20. Minimum: 1.\n* Unique metric streams*. Maximum: 50.\n* Transactions Per Second (TPS) per-tenancy limit for this operation: 50.\n\n*A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits.\nA dimension is a qualifier provided in a metric definition.\nA metric stream is an individual set of aggregated data for a metric, typically specific to a resource.\nFor more information about metric-related concepts, see [Monitoring Concepts](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).\n\nThe endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example:\n\nhttps://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - query: Execute a SQL query.",
|
|
"api_call": "POST /query",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Execute a SQL query.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - query: Prepare a SQL statement for use in a query with variable substitution.\n",
|
|
"api_call": "GET /query/prepare",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"statement": "string: (Required) A NoSQL SQL statement."
|
|
},
|
|
"functionality": "Prepare a SQL statement for use in a query with variable substitution.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - query: Check the syntax and return a brief summary of a SQL statement.",
|
|
"api_call": "GET /query/summarize",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"statement": "string: (Required) A NoSQL SQL statement."
|
|
},
|
|
"functionality": "Check the syntax and return a brief summary of a SQL statement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes > {indexName}: Delete an index.",
|
|
"api_call": "DELETE /tables/{tableNameOrId}/indexes/{indexName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"isIfExists": "boolean: Set as true to select \"if exists\" behavior.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID.",
|
|
"indexName": "[REQUIRED] string: (Required) The name of a table's index."
|
|
},
|
|
"functionality": "Delete an index from the table identified by tableNameOrId.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes > {indexName}: Get information about a single index.",
|
|
"api_call": "GET /tables/{tableNameOrId}/indexes/{indexName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID.",
|
|
"indexName": "[REQUIRED] string: (Required) The name of a table's index."
|
|
},
|
|
"functionality": "Get information about a single index.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes: Get a list of indexes on a table.",
|
|
"api_call": "GET /tables/{tableNameOrId}/indexes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"name": "string: A shell-globbing-style (*?[]) filter for names.",
|
|
"lifecycleState": "string: Filter list by the lifecycle state of the item.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be\nprovided. Default order for timeCreated is descending. Default\norder for name is ascending. If no value is specified\ntimeCreated is default.\n",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get a list of indexes on a table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes: Create a new index.",
|
|
"api_call": "POST /tables/{tableNameOrId}/indexes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried\nin case of a timeout or server error without risk of executing\nthat same action again. Retry tokens expire after 24 hours, but\ncan be invalidated before then due to conflicting\noperations. For example, if a resource has been deleted and\npurged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Create a new index on the table identified by tableNameOrId.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > rows: Delete a single row from the table, by primary key.",
|
|
"api_call": "DELETE /tables/{tableNameOrId}/rows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"key": "string: (Required) An array of strings, each of the format \"column-name:value\",\nrepresenting the primary key of the row.\n",
|
|
"isGetReturnRow": "boolean: If true, and the operation fails due to an option setting\n(ifVersion et al), then the existing row will be returned.\n",
|
|
"timeoutInMs": "integer: Timeout setting for this operation.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Delete a single row from the table, by primary key.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > rows: Get a single row from the table by primary key.",
|
|
"api_call": "GET /tables/{tableNameOrId}/rows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"key": "string: (Required) An array of strings, each of the format \"column-name:value\",\nrepresenting the primary key of the row.\n",
|
|
"consistency": "string: Consistency requirement for a read operation.",
|
|
"timeoutInMs": "integer: Timeout setting for this operation.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get a single row from the table by primary key.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > rows: Write a single row into the table.",
|
|
"api_call": "PUT /tables/{tableNameOrId}/rows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Write a single row into the table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Delete a table by tableNameOrId.",
|
|
"api_call": "DELETE /tables/{tableNameOrId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"isIfExists": "boolean: Set as true to select \"if exists\" behavior.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Delete a table by tableNameOrId.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Get table info by identifier.",
|
|
"api_call": "GET /tables/{tableNameOrId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get table info by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Alter the table identified by tableNameOrId.",
|
|
"api_call": "PUT /tables/{tableNameOrId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Alter the table identified by tableNameOrId,\nchanging schema, limits, or tags\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Change a table's compartment.",
|
|
"api_call": "POST /tables/{tableNameOrId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried\nin case of a timeout or server error without risk of executing\nthat same action again. Retry tokens expire after 24 hours, but\ncan be invalidated before then due to conflicting\noperations. For example, if a resource has been deleted and\npurged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Change a table's compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Get table usage info.",
|
|
"api_call": "GET /tables/{tableNameOrId}/usage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"timeStart": "number: The start time to use for the request. If no time range\nis set for this request, the most recent complete usage\nrecord is returned.\n",
|
|
"timeEnd": "number: The end time to use for the request.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get table usage info.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables: Get a list of tables in a compartment.",
|
|
"api_call": "GET /tables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"name": "string: A shell-globbing-style (*?[]) filter for names.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be\nprovided. Default order for timeCreated is descending. Default\norder for name is ascending. If no value is specified\ntimeCreated is default.\n",
|
|
"lifecycleState": "string: Filter list by the lifecycle state of the item."
|
|
},
|
|
"functionality": "Get a list of tables in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables: Create a new table.",
|
|
"api_call": "POST /tables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried\nin case of a timeout or server error without risk of executing\nthat same action again. Retry tokens expire after 24 hours, but\ncan be invalidated before then due to conflicting\noperations. For example, if a resource has been deleted and\npurged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a new table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: Cancel a work request operation with the given ID.",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancel a work request operation with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: Get the status of the work request with the given ID.",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Get the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: List work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests: List the work requests in a compartment.",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "List the work requests in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {id}: Get Confirm Subscription",
|
|
"api_call": "GET /subscriptions/{id}/confirmation",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"token": "string: (Required) The subscription confirmation token.",
|
|
"protocol": "string: (Required) The protocol used for the subscription.\n\nAllowed values:\n * `CUSTOM_HTTPS`\n * `EMAIL`\n * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)\n * `ORACLE_FUNCTIONS`\n * `PAGERDUTY`\n * `SLACK`\n * `SMS`\n\nFor information about subscription protocols, see\n[To create a subscription](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#concepts__subscriptionprotocols).\n",
|
|
"id": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to get the confirmation details for.\n"
|
|
},
|
|
"functionality": "Gets the confirmation details for the specified subscription.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {id}: Resend Subscription Confirmation",
|
|
"api_call": "POST /subscriptions/{id}/resendConfirmation",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"id": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to resend the confirmation for.\n"
|
|
},
|
|
"functionality": "Resends the confirmation details for the specified subscription.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {id}: Get Unsubscription",
|
|
"api_call": "GET /subscriptions/{id}/unsubscription",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"token": "string: (Required) The subscription confirmation token.",
|
|
"protocol": "string: (Required) The protocol used for the subscription.\n\nAllowed values:\n * `CUSTOM_HTTPS`\n * `EMAIL`\n * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)\n * `ORACLE_FUNCTIONS`\n * `PAGERDUTY`\n * `SLACK`\n * `SMS`\n\nFor information about subscription protocols, see\n[To create a subscription](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#concepts__subscriptionprotocols).\n",
|
|
"id": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to unsubscribe from.\n"
|
|
},
|
|
"functionality": "Unsubscribes the subscription from the topic.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Get Subscription",
|
|
"api_call": "GET /subscriptions/{subscriptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to retrieve.\n"
|
|
},
|
|
"functionality": "Gets the specified subscription's configuration information.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Update Subscription",
|
|
"api_call": "PUT /subscriptions/{subscriptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to update.\n"
|
|
},
|
|
"functionality": "Updates the specified subscription's configuration.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Delete Subscription",
|
|
"api_call": "DELETE /subscriptions/{subscriptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to delete.\n"
|
|
},
|
|
"functionality": "Deletes the specified subscription.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Change Subscription Compartment",
|
|
"api_call": "POST /subscriptions/{subscriptionId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to move.\n"
|
|
},
|
|
"functionality": "Moves a subscription into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions: List Subscriptions",
|
|
"api_call": "GET /subscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n",
|
|
"topicId": "string: Return all subscriptions that are subscribed to the given topic OCID. Either this query parameter or the compartmentId query parameter must be set.\n",
|
|
"page": "string: For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the subscriptions in the specified compartment or topic.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions: Create Subscription",
|
|
"api_call": "POST /subscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in \"Pending\" status until it has been confirmed.\nFor information about confirming subscriptions, see\n[To confirm a subscription](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub).\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Get Topic",
|
|
"api_call": "GET /topics/{topicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to retrieve.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 120.\n"
|
|
},
|
|
"functionality": "Gets the specified topic's configuration information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Update Topic",
|
|
"api_call": "PUT /topics/{topicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to update.\n"
|
|
},
|
|
"functionality": "Updates the specified topic's configuration.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Delete Topic",
|
|
"api_call": "DELETE /topics/{topicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to delete.\n"
|
|
},
|
|
"functionality": "Deletes the specified topic.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Change Topic Compartment",
|
|
"api_call": "POST /topics/{topicId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to move.\n"
|
|
},
|
|
"functionality": "Moves a topic into a different compartment within the same tenancy. For information about moving resources\nbetween compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Publish Message",
|
|
"api_call": "POST /topics/{topicId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"messageType": "string: **Deprecated.**\nThis attribute is deprecated, as is support for JSON.\nYou can send a JSON payload even when transmitting the payload as a raw string.\nConfigure your receiving system to read the raw payload as JSON format.\n\nType of message body in the request.\nFor `messageType` of JSON, a default key-value pair is required. Example: `{\"default\": \"Alarm breached\", \"Email\": \"Alarm breached: <url>\"}.`\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.\n"
|
|
},
|
|
"functionality": "Publishes a message to the specified topic.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nLimits information follows.\n\nMessage size limit per request: 64KB.\n\nMessage delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the `EMAIL` protocol.\nHTTP-based protocols use URL endpoints that begin with \"http:\" or \"https:\".\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)\n\nFor more information about publishing messages, see [Publishing Messages](https://docs.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm).\nFor steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics: List Topics",
|
|
"api_call": "GET /topics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n",
|
|
"page": "string: For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. Only one field can be selected for sorting.\n",
|
|
"sortOrder": "string: The sort order to use (ascending or descending).\n",
|
|
"lifecycleState": "string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists topics in the specified compartment.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 120.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics: Create Topic",
|
|
"api_call": "POST /topics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a topic in the specified compartment. For general information about topics, see\n[Managing Topics and Subscriptions](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm).\n\nFor the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside.\nFor information about access control and compartments, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).\n\nYou must specify a display name for the topic.\n\nAll Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an\nOracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also\nretrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the\nConsole. For more information, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions > reencrypt: Re-encrypt Bucket Data Encryption Key",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/reencrypt",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Re-encrypts the unique data encryption key that encrypts each object written to the bucket by using the most recent \nversion of the master encryption key assigned to the bucket. (All data encryption keys are encrypted by a master \nencryption key. Master encryption keys are assigned to buckets and managed by Oracle by default, but you can assign \na key that you created and control through the Oracle Cloud Infrastructure Key Management service.) The kmsKeyId property \nof the bucket determines which master encryption key is assigned to the bucket. If you assigned a different Key Management \nmaster encryption key to the bucket, you can call this API to re-encrypt all data encryption keys with the newly \nassigned key. Similarly, you might want to re-encrypt all data encryption keys if the assigned key has been rotated to \na new key version since objects were last added to the bucket. If you call this API and there is no kmsKeyId associated \nwith the bucket, the call will fail.\n\nCalling this API starts a work request task to re-encrypt the data encryption key of all objects in the bucket. Only \nobjects created before the time of the API call will be re-encrypted. The call can take a long time, depending on how many \nobjects are in the bucket and how big they are. This API returns a work request ID that you can use to retrieve the status \nof the work request task.\nAll the versions of objects will be re-encrypted whether versioning is enabled or suspended at the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions > reencrypt: Re-encrypt the data encryption keys associated with an object",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/reencrypt/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"versionId": "string: VersionId used to identify a particular version of the object",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Re-encrypts the data encryption keys that encrypt the object and its chunks. By default, when you create a bucket, the Object Storage\nservice manages the master encryption key used to encrypt each object's data encryption keys. The encryption mechanism that you specify for\nthe bucket applies to the objects it contains.\n\nYou can alternatively employ one of these encryption strategies for an object:\n\n- You can assign a key that you created and control through the Oracle Cloud Infrastructure Vault service.\n\n- You can encrypt an object using your own encryption key. The key you supply is known as a customer-provided encryption key (SSE-C).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Creates a copy object request.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/copyObject",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-source-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm to use to decrypt the source\nobject. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-source-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to decrypt\nthe source object. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-source-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key used to\ndecrypt the source object. This value is used to check the integrity of the encryption key. For\nmore information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a request to copy an object within a region or to another region.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Stops the replication policy associated with a destination bucket.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/makeBucketWritable",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Stops replication to the destination bucket and removes the replication policy. When the replication\npolicy was created, this destination bucket became read-only except for new and changed objects replicated\nautomatically from the source bucket. MakeBucketWritable removes the replication policy. This bucket is no\nlonger the target for replication and is now writable, allowing users to make changes to bucket contents.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Rename Object",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/renameObject",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Rename an object in the given Object Storage namespace.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Restore Objects",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/restoreObjects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Restores one or more objects specified by the objectName parameter.\nBy default objects will be restored for 24 hours. Duration can be configured using the hours parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Move the object into a different storage tier",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/updateObjectStorageTier",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Changes the storage tier of the object specified by the objectName parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > l: GET object lifecycle policy",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/l",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Gets the object lifecycle policy for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > l: Put object lifecycle policy.",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/l",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates or replaces the object lifecycle policy for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > l: Delete object lifecycle policy",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/l",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Deletes the object lifecycle policy for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: GET Object",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"range": "string: Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7233#section-2.1).\nNote that only a single range of bytes is supported.\n",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Gets the metadata and body of an object. \n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: PUT Object",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Expect": "string: A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent.\nIf no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body.\nThe only allowed value for this parameter is \"100-Continue\" (case-insensitive).\n",
|
|
"Content-Length": "integer: (Required) The content length of the body.",
|
|
"Content-MD5": "string: The optional base-64 header that defines the encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object\nStorage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the\nMD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error\nis returned with the message:\n\n\"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)\"\n",
|
|
"Content-Language": "string: The optional Content-Language header that defines the content language of the object to upload. Specifying\nvalues for this header has no effect on Object Storage behavior. Programs that read the object determine what\nto do based on the value provided. For example, you could use this header to identify and differentiate objects\nbased on a particular language.\n",
|
|
"Content-Encoding": "string: The optional Content-Encoding header that defines the content encodings that were applied to the object to\nupload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the\nobject determine what to do based on the value provided. For example, you could use this header to determine\nwhat decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of\nthe object.\n",
|
|
"Content-Disposition": "string: The optional Content-Disposition header that defines presentational information for the object to be\nreturned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object\nStorage behavior. Programs that read the object determine what to do based on the value provided.\nFor example, you could use this header to let users download objects with custom filenames in a browser.\n",
|
|
"Cache-Control": "string: The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and\nHeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs\nthat read the object determine what to do based on the value provided.\nFor example, you could use this header to identify objects that require caching restrictions.\n",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"storage-tier": "string: The storage tier that the object should be stored in. If not specified, the object will be stored in\nthe same storage tier as the bucket.\n",
|
|
"opc-meta-*": "string: Optional user-defined metadata key and value.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by\nPutObject is 50 GiB.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements. \n\nSee [Special Instructions for Object Storage PUT](https://docs.oracle.com/iaas/Content/API/Concepts/signingrequests.htm#ObjectStoragePut)\nfor request signature requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: DELETE Object",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Deletes an object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: HEAD Object",
|
|
"api_call": "HEAD /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Gets the user-defined metadata and entity tag (ETag) for an object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o: List Objects",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/o",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists the objects in a bucket. By default, ListObjects returns object names only. See the `fields`\nparameter for other fields that you can optionally include in ListObjects response.\n\nListObjects returns at most 1000 objects. To paginate through more objects, use the returned 'nextStartWith'\nvalue with the 'start' parameter. To filter which objects ListObjects returns, use the 'start' and 'end'\nparameters.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p > {par Id}: GET Preauthenticated Request",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/p/{parId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"parId": "[REQUIRED] string: (Required) The unique identifier for the pre-authenticated request. This can be used to manage operations against\nthe pre-authenticated request, such as GET or DELETE.\n"
|
|
},
|
|
"functionality": "Gets the pre-authenticated request for the bucket.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p > {par Id}: DELETE Preauthenticated Request",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/p/{parId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"parId": "[REQUIRED] string: (Required) The unique identifier for the pre-authenticated request. This can be used to manage operations against\nthe pre-authenticated request, such as GET or DELETE.\n"
|
|
},
|
|
"functionality": "Deletes the pre-authenticated request for the bucket.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p: List Preauthenticated Requests",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/p/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists pre-authenticated requests for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p: Create Preauthenticated Request",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/p/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a pre-authenticated request specific to the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies > {replication Id}: Get replication policy.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"replicationId": "[REQUIRED] string: (Required) The ID of the replication policy."
|
|
},
|
|
"functionality": "Get the replication policy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies > {replication Id}: Delete replication policy.",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"replicationId": "[REQUIRED] string: (Required) The ID of the replication policy."
|
|
},
|
|
"functionality": "Deletes the replication policy associated with the source bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies: List the replication policies associated with a bucket.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/replicationPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "List the replication policies associated with a bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies: Create replication policy.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/replicationPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a replication policy for the specified bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules > {retention Rule Id}: Get the specified retention rule.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"retentionRuleId": "[REQUIRED] string: (Required) The ID of the retention rule."
|
|
},
|
|
"functionality": "Get the specified retention rule.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules > {retention Rule Id}: Update the specified retention rule.",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"retentionRuleId": "[REQUIRED] string: (Required) The ID of the retention rule."
|
|
},
|
|
"functionality": "Updates the specified retention rule. Rule changes take effect typically within 30 seconds.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules > {retention Rule Id}: Delete the specified retention rule.",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"retentionRuleId": "[REQUIRED] string: (Required) The ID of the retention rule."
|
|
},
|
|
"functionality": "Deletes the specified rule. The deletion takes effect typically within 30 seconds.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules: List the retention rules for a bucket.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/retentionRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Accept": "string",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "List the retention rules for a bucket. The retention rules are sorted based on creation time,\nwith the most recently created retention rule returned first.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules: Create a new retention rule.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/retentionRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a new retention rule in the specified bucket. The new rule will take effect typically within 30 seconds.\nNote that a maximum of 100 rules are supported on a bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: List Multipart Upload Parts",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Lists the parts of an in-progress multipart upload.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: Upload Multipart Object Part",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"Expect": "string: A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent.\nIf no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body.\nThe only allowed value for this parameter is \"100-Continue\" (case-insensitive).\n",
|
|
"Content-Length": "integer: (Required) The content length of the body.",
|
|
"Content-MD5": "string: The optional base-64 header that defines the encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object\nStorage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the\nMD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error\nis returned with the message:\n\n\"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)\"\n",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"uploadPartNum": "integer: (Required) The part number that identifies the object part currently being uploaded.",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Uploads a single part of a multipart upload.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: Commit Multipart Upload",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: Abort Multipart Upload",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Aborts an in-progress multipart upload and deletes all parts that have been uploaded.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u: List Multipart Uploads",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/u",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u: Create Multipart Upload",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/u",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Starts a new multipart upload to a specific object in the given bucket in the given namespace.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: GET Bucket",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"fields": "string: Bucket summary includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated',\nand 'etag' fields. This parameter can also include 'approximateCount' (approximate number of objects), 'approximateSize'\n(total approximate size in bytes of all objects) and 'autoTiering' (state of auto tiering on the bucket).\nFor example 'approximateCount,approximateSize,autoTiering'.\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Gets the current representation of the given bucket in the given Object Storage namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: POST Bucket",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Performs a partial or full update of a bucket's user-defined metadata.\n\nUse UpdateBucket to move a bucket from one compartment to another within the same tenancy. Supply the compartmentID\nof the compartment that you want to move the bucket to. For more information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: DELETE Bucket",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Deletes a bucket if the bucket is already empty. If the bucket is not empty, use\n[DeleteObject](#/en/objectstorage/20160918/methods/DeleteObject) first. In addition,\nyou cannot delete a bucket that has a multipart upload in progress or a pre-authenticated\nrequest associated with that bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: HEAD Bucket",
|
|
"api_call": "HEAD /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: List Object Versions",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/objectversions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists the object versions in a bucket.\n\nListObjectVersions returns an ObjectVersionCollection containing at most 1000 object versions. To paginate through\nmore object versions, use the returned `opc-next-page` value with the `page` request parameter.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: List the replication sources of a destination bucket.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/replicationSources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "List the replication sources of a destination bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b: List Buckets",
|
|
"api_call": "GET /n/{namespaceName}/b/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list buckets.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "Gets a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket\nand does not contain fields like the user-defined metadata.\n\nListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned\n`opc-next-page` value with the `page` request parameter.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b: Create Bucket",
|
|
"api_call": "POST /n/{namespaceName}/b/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering\nconfidential information in bucket names.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name}: GET Namespace Metadata",
|
|
"api_call": "GET /n/{namespaceName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and\ndefaultSwiftCompartmentId.\n\nAny user with the OBJECTSTORAGE_NAMESPACE_READ permission will be able to see the current metadata. If you are\nnot authorized, talk to an administrator. If you are an administrator who needs to write policies\nto give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name}: PUT Namespace",
|
|
"api_call": "PUT /n/{namespaceName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "By default, buckets created using the Amazon S3 Compatibility API or the Swift API are created in the root\ncompartment of the Oracle Cloud Infrastructure tenancy.\n\nYou can change the default Swift/Amazon S3 compartmentId designation to a different compartmentId. All\nsubsequent bucket creations will use the new default compartment, but no previously created\nbuckets will be modified. A user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default\ncompartments for Amazon S3 and Swift.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n: GET Namespace Name",
|
|
"api_call": "GET /n/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace\nis a system-generated string assigned during account creation. For some older tenancies, the namespace string may be\nthe tenancy name in all lower-case letters. You cannot edit a namespace.\n\nGetNamespace returns the name of the Object Storage namespace for the user making the request.\nIf an optional compartmentId query parameter is provided, GetNamespace returns the namespace name of the corresponding\ntenancy, provided the user has access to it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: GET Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request for the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: Cancel a work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancels a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: List Work Request Errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Lists the errors of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: List Work Request Logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Lists the logs of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list buckets.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get API",
|
|
"api_call": "GET /apis/{apiId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Gets an API by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Update the API by the identifier",
|
|
"api_call": "PUT /apis/{apiId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Updates the API with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Delete an API.",
|
|
"api_call": "DELETE /apis/{apiId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Deletes the API with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Change the API compartment.",
|
|
"api_call": "POST /apis/{apiId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Changes the API compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get raw API content",
|
|
"api_call": "GET /apis/{apiId}/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"range": "string: The Range HTTP request header indicates the part of a document that the\nserver should return. [RFC 7233](https://tools.ietf.org/html/rfc7233#section-3.1).\nNote that only a single range of bytes is supported.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Get the raw API content.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get API Deployment specification based on the API.",
|
|
"api_call": "GET /apis/{apiId}/deploymentSpecification",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Gets an API Deployment specification by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get API content",
|
|
"api_call": "GET /apis/{apiId}/validations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Gets the API validation results.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis: Gets a list of all APIs in a compartment",
|
|
"api_call": "GET /apis",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of APIs.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis: Creates a new API",
|
|
"api_call": "POST /apis",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new API.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Get Certificate",
|
|
"api_call": "GET /certificates/{certificateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Gets a certificate by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Update Certificate by the identifier",
|
|
"api_call": "PUT /certificates/{certificateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Updates a certificate with the given identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Delete a provisioned Certificate",
|
|
"api_call": "DELETE /certificates/{certificateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Deletes the certificate with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Change the certificate compartment.",
|
|
"api_call": "POST /certificates/{certificateId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Changes the certificate compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates: Gets a list of all Certificates in a compartment",
|
|
"api_call": "GET /certificates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE` or `DELETED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of certificates.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates: Creates a new Certificate",
|
|
"api_call": "POST /certificates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new Certificate.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Get Deployment",
|
|
"api_call": "GET /deployments/{deploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Gets a deployment by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Update the Deployment identified by the id",
|
|
"api_call": "PUT /deployments/{deploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Updates the deployment with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Delete a provisioned Deployment",
|
|
"api_call": "DELETE /deployments/{deploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Deletes the deployment with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Change the deployment compartment.",
|
|
"api_call": "POST /deployments/{deploymentId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Changes the deployment compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments: Gets a list of all Deployments in a compartment",
|
|
"api_call": "GET /deployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `SUCCEEDED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of deployments.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments: Creates a new Deployment",
|
|
"api_call": "POST /deployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new deployment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Get Gateway",
|
|
"api_call": "GET /gateways/{gatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Gets a gateway by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Update the Gateway by the identifier",
|
|
"api_call": "PUT /gateways/{gatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Updates the gateway with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Delete a provisioned Gateway",
|
|
"api_call": "DELETE /gateways/{gatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Deletes the gateway with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Change the gateway compartment.",
|
|
"api_call": "POST /gateways/{gatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Changes the gateway compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways: Gets a list of all Gateways in a compartment",
|
|
"api_call": "GET /gateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `SUCCEEDED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of gateways.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways: Creates a new Gateway",
|
|
"api_call": "POST /gateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new gateway.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks > {sdk Id}: Downloadable link for the SDK.",
|
|
"api_call": "GET /sdks/{sdkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"sdkId": "[REQUIRED] string: (Required) The ocid of the SDK."
|
|
},
|
|
"functionality": "Return object store downloadable URL and metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks > {sdk Id}: Update the SDK by the identifier",
|
|
"api_call": "PUT /sdks/{sdkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"sdkId": "[REQUIRED] string: (Required) The ocid of the SDK."
|
|
},
|
|
"functionality": "Updates the SDK with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks > {sdk Id}: Deletes SDK",
|
|
"api_call": "DELETE /sdks/{sdkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"sdkId": "[REQUIRED] string: (Required) The ocid of the SDK."
|
|
},
|
|
"functionality": "Deletes provided SDK.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks: Lists SDKs",
|
|
"api_call": "GET /sdks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"sdkId": "string: The ocid of the SDK.",
|
|
"displayName": "string: A user-friendly name. Does not have to be unique, and it's changeable.\n\nExample: `My new resource`\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE` or `DELETED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n",
|
|
"apiId": "string: The ocid of the API."
|
|
},
|
|
"functionality": "Returns list of generated SDKs.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks: Creates an SDK",
|
|
"api_call": "POST /sdks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new SDK.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Gets work request status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Cancel the work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Cancels the work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Returns a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Returns a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests: List work requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"resourceId": "string: Filter work requests by the resource ocid.",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - General: Lists available SDK target languages.",
|
|
"api_call": "GET /sdkLanguageTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists programming languages in which SDK can be generated.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Delete a private reverse connection endpoint.",
|
|
"api_call": "DELETE /aiPrivateEndpoints/{aiPrivateEndpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Deletes a private reverse connection endpoint by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Get private reverse connection endpoint.",
|
|
"api_call": "GET /aiPrivateEndpoints/{aiPrivateEndpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Gets a specific private reverse connection by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Update the private reverse connection endpoint identified by the id.",
|
|
"api_call": "PUT /aiPrivateEndpoints/{aiPrivateEndpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Updates the private reverse connection endpoint.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.",
|
|
"api_call": "POST /aiPrivateEndpoints/{aiPrivateEndpointId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints: Lists all the AI private endpoints in the specified compartment",
|
|
"api_call": "GET /aiPrivateEndpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"displayName": "string: A filter to return only resources that match the entire display name given.",
|
|
"id": "string: unique AiPrivateEndpoint identifier",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
|
|
},
|
|
"functionality": "Returns a list of all the AI private endpoints in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints: Create a new private reverse connection endpoint.",
|
|
"api_call": "POST /aiPrivateEndpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new private reverse connection endpoint.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Delete a provisioned DataAsset",
|
|
"api_call": "DELETE /dataAssets/{dataAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Deletes a DataAsset resource by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Get DataAsset",
|
|
"api_call": "GET /dataAssets/{dataAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Gets a DataAsset by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Update the DataAsset identified by the id",
|
|
"api_call": "PUT /dataAssets/{dataAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Updates the DataAsset",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Change Data Asset Compartment",
|
|
"api_call": "POST /dataAssets/{dataAssetId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Changing the compartment of a data asset.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets: Gets a list of all DataAssets in a compartment",
|
|
"api_call": "GET /dataAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"projectId": "string: The ID of the project for which to list the objects.",
|
|
"displayName": "string: A filter to return only resources that match the entire display name given.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
|
|
},
|
|
"functionality": "Returns a list of DataAssets.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets: Creates a new DataAsset",
|
|
"api_call": "POST /dataAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new DataAsset.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Delete a provisioned Model",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Deletes an ai model resource by identifier. This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Get a Model",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Gets a Model by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Update the Model identified by the id",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Updates the Model",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Moves a Model resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models: Gets a list of all Models in a compartment",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"projectId": "string: The ID of the project for which to list the objects.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of Models.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models: Creates a new Model for training with the training data",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new Model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Delete a provisioned Project",
|
|
"api_call": "DELETE /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Deletes a Project resource by identifier. This operation fails with a 409 error unless all associated resources (models deployments or data assets) are in a DELETED state. You must delete all associated resources before deleting a project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Get Project",
|
|
"api_call": "GET /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Gets a Project by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Update the Project identified by the id",
|
|
"api_call": "PUT /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Updates the Project",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /projects/{projectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Moves a Project resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects: Gets a list of all Projects in a compartment.",
|
|
"api_call": "GET /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of Projects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects: Creates a new Project in the compartment.",
|
|
"api_call": "POST /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new Project.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: Cancel the work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancel work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: GET Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"workRequestId": "string: The ID of the asynchronous work request.",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - General: Detect Anomalies with an anomaly model and detection data",
|
|
"api_call": "POST /actions/detectAnomalies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Make a detect call with an anomaly model and detection data",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > configuration: GetContainerConfiguration",
|
|
"api_call": "GET /container/configuration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Get container configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > configuration: UpdateContainerConfiguration",
|
|
"api_call": "PUT /container/configuration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Update container configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures > {image Signature Id}: DeleteContainerImageSignature",
|
|
"api_call": "DELETE /container/imageSignatures/{imageSignatureId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageSignatureId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image signature.\n\nExample: `ocid1.containersignature.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Delete a container image signature.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures > {image Signature Id}: GetContainerImageSignature",
|
|
"api_call": "GET /container/imageSignatures/{imageSignatureId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageSignatureId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image signature.\n\nExample: `ocid1.containersignature.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Get container image signature metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures: ListContainerImageSignatures",
|
|
"api_call": "GET /container/imageSignatures",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentIdInSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"imageId": "string: A filter to return a container image summary only for the specified container image OCID.\n",
|
|
"repositoryId": "string: A filter to return container images only for the specified container repository OCID.\n",
|
|
"repositoryName": "string: A filter to return container images or container image signatures that match the repository name.\n\nExample: `foo` or `foo*`\n",
|
|
"imageDigest": "string: The digest of the container image.\n\nExample: `sha256:e7d38b3517548a1c71e41bffe9c8ae6d6d29546ce46bf62159837aad072c90aa`\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "List container image signatures in an image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures: CreateContainerImageSignature",
|
|
"api_call": "POST /container/imageSignatures",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Upload a signature to an image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id} > actions: RemoveContainerVersion",
|
|
"api_call": "POST /container/images/{imageId}/actions/removeVersion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Remove version from container image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id} > actions: RestoreContainerImage",
|
|
"api_call": "POST /container/images/{imageId}/actions/restore",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Restore a container image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id}: DeleteContainerImage",
|
|
"api_call": "DELETE /container/images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Delete a container image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id}: GetContainerImage",
|
|
"api_call": "GET /container/images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Get container image metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images: ListContainerImages",
|
|
"api_call": "GET /container/images",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentIdInSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "List container images in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: DeleteContainerRepository",
|
|
"api_call": "DELETE /container/repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Delete container repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: GetContainerRepository",
|
|
"api_call": "GET /container/repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Get container repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: UpdateContainerRepository",
|
|
"api_call": "PUT /container/repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Modify the properties of a container repository. Avoid entering confidential information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: ChangeContainerRepositoryCompartment",
|
|
"api_call": "POST /container/repositories/{repositoryId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Moves a container repository into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories: ListContainerRepositories",
|
|
"api_call": "GET /container/repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentIdInSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "List container repositories in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories: CreateContainerRepository",
|
|
"api_call": "POST /container/repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new empty container repository. Avoid entering confidential information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts > {artifact Id}: DeleteGenericArtifact",
|
|
"api_call": "DELETE /generic/artifacts/{artifactId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"artifactId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Deletes an artifact with a specified [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts > {artifact Id}: GetGenericArtifact",
|
|
"api_call": "GET /generic/artifacts/{artifactId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"artifactId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Gets information about an artifact with a specified [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts > {artifact Id}: UpdateGenericArtifact",
|
|
"api_call": "PUT /generic/artifacts/{artifactId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"artifactId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Updates the artifact with the specified [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can only update the tags of an artifact.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts: ListGenericArtifacts",
|
|
"api_call": "GET /generic/artifacts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"repositoryId": "string: (Required) A filter to return the artifacts only for the specified repository OCID.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists artifacts in the specified repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > repositories/{repository Id}/artifact Paths/{artifact Path}/versions/{version}: DeleteGenericArtifactByPath",
|
|
"api_call": "DELETE /generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n",
|
|
"artifactPath": "[REQUIRED] string: (Required) A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n",
|
|
"version": "[REQUIRED] string: (Required) A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n"
|
|
},
|
|
"functionality": "Deletes an artifact with a specified `artifactPath` and `version`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > repositories/{repository Id}/artifact Paths/{artifact Path}/versions/{version}: GetGenericArtifactByPath",
|
|
"api_call": "GET /generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n",
|
|
"artifactPath": "[REQUIRED] string: (Required) A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n",
|
|
"version": "[REQUIRED] string: (Required) A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n"
|
|
},
|
|
"functionality": "Gets information about an artifact with a specified `artifactPath` and `version`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > repositories/{repository Id}/artifact Paths/{artifact Path}/versions/{version}: UpdateGenericArtifactByPath",
|
|
"api_call": "PUT /generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n",
|
|
"artifactPath": "[REQUIRED] string: (Required) A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n",
|
|
"version": "[REQUIRED] string: (Required) A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n"
|
|
},
|
|
"functionality": "Updates an artifact with a specified `artifactPath` and `version`. You can only update the tags of an artifact.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: DeleteRepository",
|
|
"api_call": "DELETE /repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Deletes the specified repository. This operation fails unless all associated artifacts are in a DELETED state. You must delete all associated artifacts before deleting a repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: GetRepository",
|
|
"api_call": "GET /repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Gets the specified repository's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: UpdateRepository",
|
|
"api_call": "PUT /repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Updates the properties of a repository. You can update the `displayName` and `description` properties.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: ChangeRepositoryCompartment",
|
|
"api_call": "POST /repositories/{repositoryId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Moves a repository into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories: ListRepositories",
|
|
"api_call": "GET /repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists repositories in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories: CreateRepository",
|
|
"api_call": "POST /repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new repository for storing artifacts.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id} > actions: Initiates cluster migration to use native VCN.",
|
|
"api_call": "POST /clusters/{clusterId}/actions/migrateToNativeVcn",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Initiates cluster migration to use native VCN.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id} > actions: Update cluster endpoint details.",
|
|
"api_call": "POST /clusters/{clusterId}/actions/updateEndpointConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Update the details of the cluster endpoint configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Delete a cluster.",
|
|
"api_call": "DELETE /clusters/{clusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Delete a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Get cluster details.",
|
|
"api_call": "GET /clusters/{clusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Get the details of a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Update cluster details.",
|
|
"api_call": "PUT /clusters/{clusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Update the details of a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Create the cluster kubeconfig.",
|
|
"api_call": "POST /clusters/{clusterId}/kubeconfig/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Create the Kubeconfig YAML for a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Get details on a cluster's migration to native VCN.",
|
|
"api_call": "GET /clusters/{clusterId}/migrateToNativeVcnStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Get details on a cluster's migration to native VCN.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters: List all cluster objects.",
|
|
"api_call": "GET /clusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum. For important details about how pagination works,\nsee [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The optional order in which to sort the results.",
|
|
"sortBy": "string: The optional field to sort the results by."
|
|
},
|
|
"functionality": "List all the cluster objects in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters: Create a new cluster.",
|
|
"api_call": "POST /clusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token you supply to uniquely identify the request and provide idempotency if\nthe request is retried. Idempotency tokens expire after 24 hours.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools > {node Pool Id}: Delete a node pool.",
|
|
"api_call": "DELETE /nodePools/{nodePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"nodePoolId": "[REQUIRED] string: (Required) The OCID of the node pool."
|
|
},
|
|
"functionality": "Delete a node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools > {node Pool Id}: Get node pool details.",
|
|
"api_call": "GET /nodePools/{nodePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"nodePoolId": "[REQUIRED] string: (Required) The OCID of the node pool."
|
|
},
|
|
"functionality": "Get the details of a node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools > {node Pool Id}: Update node pool details.",
|
|
"api_call": "PUT /nodePools/{nodePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"nodePoolId": "[REQUIRED] string: (Required) The OCID of the node pool."
|
|
},
|
|
"functionality": "Update the details of a node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools: List all node pools.",
|
|
"api_call": "GET /nodePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"clusterId": "string: The OCID of the cluster.",
|
|
"name": "string: The name to filter on.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum. For important details about how pagination works,\nsee [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The optional order in which to sort the results.",
|
|
"sortBy": "string: The optional field to sort the results by."
|
|
},
|
|
"functionality": "List all the node pools in a compartment, and optionally filter by cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools: Create a new node pool.",
|
|
"api_call": "POST /nodePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token you supply to uniquely identify the request and provide idempotency if\nthe request is retried. Idempotency tokens expire after 24 hours.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Cancel a work request.",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Cancel a work request that has not started.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Get work request details.",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Get the details of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Get work request errors.",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Get the errors of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Get work request logs.",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Get the logs of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests: List all work requests.",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"clusterId": "string: The OCID of the cluster.",
|
|
"resourceId": "string: The OCID of the resource associated with a work request",
|
|
"resourceType": "string: Type of the resource associated with a work request",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum. For important details about how pagination works,\nsee [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The optional order in which to sort the results.",
|
|
"sortBy": "string: The optional field to sort the results by."
|
|
},
|
|
"functionality": "List all work requests in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - General: Get cluster options.",
|
|
"api_call": "GET /clusterOptions/{clusterOptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The OCID of the compartment.",
|
|
"clusterOptionId": "[REQUIRED] string: (Required) The id of the option set to retrieve. Use \"all\" get all options, or use a cluster ID to get options specific to the provided cluster."
|
|
},
|
|
"functionality": "Get options available for clusters.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - General: Get node pool options.",
|
|
"api_call": "GET /nodePoolOptions/{nodePoolOptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The OCID of the compartment.",
|
|
"nodePoolOptionId": "[REQUIRED] string: (Required) The id of the option set to retrieve. Use \"all\" get all options, or use a cluster ID to get options specific to the provided cluster."
|
|
},
|
|
"functionality": "Get options available for node pools.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id} > resource Versions > {resource Version}: GetAppCatalogListingResourceVersion",
|
|
"api_call": "GET /appCatalogListings/{listingId}/resourceVersions/{resourceVersion}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing.",
|
|
"resourceVersion": "[REQUIRED] string: (Required) Listing Resource Version."
|
|
},
|
|
"functionality": "Gets the specified listing resource version.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id} > resource Versions > {resource Version}: GetAppCatalogListingAgreements",
|
|
"api_call": "GET /appCatalogListings/{listingId}/resourceVersions/{resourceVersion}/agreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing.",
|
|
"resourceVersion": "[REQUIRED] string: (Required) Listing Resource Version."
|
|
},
|
|
"functionality": "Retrieves the agreements for a particular resource version of a listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id} > resource Versions: ListAppCatalogListingResourceVersions",
|
|
"api_call": "GET /appCatalogListings/{listingId}/resourceVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing."
|
|
},
|
|
"functionality": "Gets all resource versions for a particular listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id}: GetAppCatalogListing",
|
|
"api_call": "GET /appCatalogListings/{listingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing."
|
|
},
|
|
"functionality": "Gets the specified listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings: ListAppCatalogListings",
|
|
"api_call": "GET /appCatalogListings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"publisherName": "string: A filter to return only the publisher that matches the given publisher name exactly.\n",
|
|
"publisherType": "string: A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD.\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n"
|
|
},
|
|
"functionality": "Lists the published listings.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Subscriptions: DeleteAppCatalogSubscription",
|
|
"api_call": "DELETE /appCatalogSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "string: (Required) The OCID of the listing.",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"resourceVersion": "string: (Required) Listing Resource Version."
|
|
},
|
|
"functionality": "Delete a subscription for a listing resource version for a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Subscriptions: ListAppCatalogSubscriptions",
|
|
"api_call": "GET /appCatalogSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"listingId": "string: A filter to return only the listings that matches the given listing id.\n"
|
|
},
|
|
"functionality": "Lists subscriptions for a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Subscriptions: CreateAppCatalogSubscription",
|
|
"api_call": "POST /appCatalogSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - block Volume Replicas: ListBlockVolumeReplicas",
|
|
"api_call": "GET /blockVolumeReplicas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the block volume replicas in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - block Volume Replicas: GetBlockVolumeReplica",
|
|
"api_call": "GET /blockVolumeReplicas/{blockVolumeReplicaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"blockVolumeReplicaId": "[REQUIRED] string: (Required) The OCID of the block volume replica."
|
|
},
|
|
"functionality": "Gets information for the specified block volume replica.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments > {boot Volume Attachment Id}: DetachBootVolume",
|
|
"api_call": "DELETE /bootVolumeAttachments/{bootVolumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the boot volume attachment."
|
|
},
|
|
"functionality": "Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment.\n\nThis is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily\nuntil the attachment is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments > {boot Volume Attachment Id}: GetBootVolumeAttachment",
|
|
"api_call": "GET /bootVolumeAttachments/{bootVolumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the boot volume attachment."
|
|
},
|
|
"functionality": "Gets information about the specified boot volume attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments: ListBootVolumeAttachments",
|
|
"api_call": "GET /bootVolumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"bootVolumeId": "string: The OCID of the boot volume."
|
|
},
|
|
"functionality": "Lists the boot volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, boot volume OCID, or both.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments: AttachBootVolume",
|
|
"api_call": "POST /bootVolumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Attaches the specified boot volume to the specified instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id} > actions: ChangeBootVolumeBackupCompartment",
|
|
"api_call": "POST /bootVolumeBackups/{bootVolumeBackupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Moves a boot volume backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id} > actions: CreateBootVolumeBackupCopy",
|
|
"api_call": "POST /bootVolumeBackups/{bootVolumeBackupId}/actions/copy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Creates a boot volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id}: DeleteBootVolumeBackup",
|
|
"api_call": "DELETE /bootVolumeBackups/{bootVolumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Deletes a boot volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id}: GetBootVolumeBackup",
|
|
"api_call": "GET /bootVolumeBackups/{bootVolumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Gets information for the specified boot volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id}: UpdateBootVolumeBackup",
|
|
"api_call": "PUT /bootVolumeBackups/{bootVolumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Updates the display name for the specified boot volume backup.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups: ListBootVolumeBackups",
|
|
"api_call": "GET /bootVolumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"bootVolumeId": "string: The OCID of the boot volume.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sourceBootVolumeBackupId": "string: A filter to return only resources that originated from the given source boot volume backup.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is\ncase-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups: CreateBootVolumeBackup",
|
|
"api_call": "POST /bootVolumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Replicas: ListBootVolumeReplicas",
|
|
"api_call": "GET /bootVolumeReplicas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the boot volume replicas in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Replicas: GetBootVolumeReplica",
|
|
"api_call": "GET /bootVolumeReplicas/{bootVolumeReplicaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeReplicaId": "[REQUIRED] string: (Required) The OCID of the boot volume replica."
|
|
},
|
|
"functionality": "Gets information for the specified boot volume replica.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id} > kms Key: DeleteBootVolumeKmsKey",
|
|
"api_call": "DELETE /bootVolumes/{bootVolumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Removes the specified boot volume's assigned Key Management encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id} > kms Key: GetBootVolumeKmsKey",
|
|
"api_call": "GET /bootVolumes/{bootVolumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Gets the Key Management encryption key assigned to the specified boot volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id} > kms Key: UpdateBootVolumeKmsKey",
|
|
"api_call": "PUT /bootVolumes/{bootVolumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Updates the specified volume with a new Key Management master encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: DeleteBootVolume",
|
|
"api_call": "DELETE /bootVolumes/{bootVolumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Deletes the specified boot volume. The volume cannot have an active connection to an instance.\nTo disconnect the boot volume from a connected instance, see\n[Disconnecting From a Boot Volume](/iaas/Content/Block/Tasks/deletingbootvolume.htm).\n**Warning:** All data on the boot volume will be permanently lost when the boot volume is deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: GetBootVolume",
|
|
"api_call": "GET /bootVolumes/{bootVolumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Gets information for the specified boot volume.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: UpdateBootVolume",
|
|
"api_call": "PUT /bootVolumes/{bootVolumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Updates the specified boot volume's display name, defined tags, and free-form tags.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: ChangeBootVolumeCompartment",
|
|
"api_call": "POST /bootVolumes/{bootVolumeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Moves a boot volume into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes: ListBootVolumes",
|
|
"api_call": "GET /bootVolumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"volumeGroupId": "string: The OCID of the volume group."
|
|
},
|
|
"functionality": "Lists the boot volumes in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes: CreateBootVolume",
|
|
"api_call": "POST /bootVolumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup.\nFor general information about boot volumes, see [Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm).\nYou may optionally specify a *display name* for the volume, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: AdvertiseByoipRange",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/advertise",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud.\nThe `ByoipRange` resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: ChangeByoipRangeCompartment",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Moves a BYOIP CIDR block to a different compartment. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: ValidateByoipRange",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/validate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already\nmodified the information for the BYOIP CIDR block with your Regional Internet Registry. See [To import a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: WithdrawByoipRange",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/withdraw",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Withdraws BGP route advertisement for the BYOIP CIDR block.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: DeleteByoipRange",
|
|
"api_call": "DELETE /byoipRanges/{byoipRangeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Deletes the specified `ByoipRange` resource.\nThe resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED.\nIt must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail.\nYou must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nIf the `ByoipRange` resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: GetByoipRange",
|
|
"api_call": "GET /byoipRanges/{byoipRangeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Gets the `ByoipRange` resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: UpdateByoipRange",
|
|
"api_call": "PUT /byoipRanges/{byoipRangeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Updates the tags or display name associated to the specified BYOIP CIDR block.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: ListByoipAllocatedRanges",
|
|
"api_call": "GET /byoipRanges/{byoipRangeId}/byoipAllocatedRanges",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.\nEach `ByoipAllocatedRange` object also lists the IP pool where it is allocated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges: ListByoipRanges",
|
|
"api_call": "GET /byoipRanges",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Lists the `ByoipRange` resources in the specified compartment.\nYou can filter the list using query parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges: CreateByoipRange",
|
|
"api_call": "POST /byoipRanges",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a subrange of the BYOIP CIDR block.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: TerminateClusterNetwork",
|
|
"api_call": "DELETE /clusterNetworks/{clusterNetworkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Terminates the specified cluster network.\n\nWhen you delete a cluster network, all of its resources are permanently deleted,\nincluding associated instances and instance pools.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: GetClusterNetwork",
|
|
"api_call": "GET /clusterNetworks/{clusterNetworkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Gets information about the specified cluster network.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: UpdateClusterNetwork",
|
|
"api_call": "PUT /clusterNetworks/{clusterNetworkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Updates the specified cluster network. The OCID of the cluster network remains the same.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: ChangeClusterNetworkCompartment",
|
|
"api_call": "POST /clusterNetworks/{clusterNetworkId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Moves a cluster network into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move a cluster network to a different compartment, associated resources such as the instances\nin the cluster network, boot volumes, and VNICs are not moved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: ListClusterNetworkInstances",
|
|
"api_call": "GET /clusterNetworks/{clusterNetworkId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Lists the instances in the specified cluster network.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks: ListClusterNetworks",
|
|
"api_call": "GET /clusterNetworks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the cluster networks in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks: CreateClusterNetwork",
|
|
"api_call": "POST /clusterNetworks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a cluster network. For more information about cluster networks, see\n[Managing Cluster Networks](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: DeleteComputeCapacityReservation",
|
|
"api_call": "DELETE /computeCapacityReservations/{capacityReservationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Deletes the specified compute capacity reservation.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: GetComputeCapacityReservation",
|
|
"api_call": "GET /computeCapacityReservations/{capacityReservationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Gets information about the specified compute capacity reservation.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: UpdateComputeCapacityReservation",
|
|
"api_call": "PUT /computeCapacityReservations/{capacityReservationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Updates the specified capacity reservation and its associated capacity configurations.\nFields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted. \nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: ChangeComputeCapacityReservationCompartment",
|
|
"api_call": "POST /computeCapacityReservations/{capacityReservationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Moves a compute capacity reservation into a different compartment. For information about\nmoving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: ListComputeCapacityReservationInstances",
|
|
"api_call": "GET /computeCapacityReservations/{capacityReservationId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations: ListComputeCapacityReservations",
|
|
"api_call": "GET /computeCapacityReservations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the compute capacity reservations that match the specified criteria and compartment.\n\nYou can limit the list by specifying a compute capacity reservation display name\n(the list will include all the identically-named compute capacity reservations in the compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations: CreateComputeCapacityReservation",
|
|
"api_call": "POST /computeCapacityReservations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new compute capacity reservation in the specified compartment and availability domain.\nCompute capacity reservations let you reserve instances in a compartment.\nWhen you launch an instance using this reservation, you are assured that you have enough space for your instance,\nand you won't get out of capacity errors.\nFor more information, see [Reserved Capacity](/iaas/Content/Compute/Tasks/reserve-capacity.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas > {compute Global Image Capability Schema Id} > versions: ListComputeGlobalImageCapabilitySchemaVersions",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"computeGlobalImageCapabilitySchemaId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema"
|
|
},
|
|
"functionality": "Lists Compute Global Image Capability Schema versions in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas > {compute Global Image Capability Schema Id} > versions: GetComputeGlobalImageCapabilitySchemaVersion",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions/{computeGlobalImageCapabilitySchemaVersionName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"computeGlobalImageCapabilitySchemaId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema",
|
|
"computeGlobalImageCapabilitySchemaVersionName": "[REQUIRED] string: (Required) The name of the compute global image capability schema version"
|
|
},
|
|
"functionality": "Gets the specified Compute Global Image Capability Schema Version",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas > {compute Global Image Capability Schema Id}: GetComputeGlobalImageCapabilitySchema",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"computeGlobalImageCapabilitySchemaId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema"
|
|
},
|
|
"functionality": "Gets the specified Compute Global Image Capability Schema",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas: ListComputeGlobalImageCapabilitySchemas",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that match the given compartment OCID exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists Compute Global Image Capability Schema in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: DeleteComputeImageCapabilitySchema",
|
|
"api_call": "DELETE /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Deletes the specified Compute Image Capability Schema\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: GetComputeImageCapabilitySchema",
|
|
"api_call": "GET /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"isMergeEnabled": "boolean: Merge the image capability schema with the global image capability schema\n",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Gets the specified Compute Image Capability Schema\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: UpdateComputeImageCapabilitySchema",
|
|
"api_call": "PUT /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Updates the specified Compute Image Capability Schema\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: ChangeComputeImageCapabilitySchemaCompartment",
|
|
"api_call": "POST /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Moves a compute image capability schema into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas: ListComputeImageCapabilitySchemas",
|
|
"api_call": "GET /computeImageCapabilitySchemas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that match the given compartment OCID exactly.\n",
|
|
"imageId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an image.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas: CreateComputeImageCapabilitySchema",
|
|
"api_call": "POST /computeImageCapabilitySchemas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates compute image capability schema.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpe Device Shapes: ListCpeDeviceShapes",
|
|
"api_call": "GET /cpeDeviceShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the CPE device types that the Networking service provides CPE configuration\ncontent for (example: Cisco ASA). The content helps a network engineer configure\nthe actual CPE device represented by a [Cpe](#/en/iaas/latest/Cpe/) object.\n\nIf you want to generate CPE configuration content for one of the returned CPE device types,\nensure that the [Cpe](#/en/iaas/latest/Cpe/) object's `cpeDeviceShapeId` attribute is set\nto the CPE device type's [OCID](/Content/General/Concepts/identifiers.htm) (returned by this operation).\n\nFor information about generating CPE configuration content, see these operations:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpe Device Shapes: GetCpeDeviceShape",
|
|
"api_call": "GET /cpeDeviceShapes/{cpeDeviceShapeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeDeviceShapeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape."
|
|
},
|
|
"functionality": "Gets the detailed information about the specified CPE device type. This might include a set of questions\nthat are specific to the particular CPE device type. The customer must supply answers to those questions\n(see [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)).\nThe service merges the answers with a template of other information for the CPE device type. The following\noperations return the merged content:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: DeleteCpe",
|
|
"api_call": "DELETE /cpes/{cpeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous\noperation. The CPE's `lifecycleState` will change to TERMINATING temporarily until the CPE is completely\nremoved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: GetCpe",
|
|
"api_call": "GET /cpes/{cpeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Gets the specified CPE's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: UpdateCpe",
|
|
"api_call": "PUT /cpes/{cpeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Updates the specified CPE's display name or tags.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: ChangeCpeCompartment",
|
|
"api_call": "POST /cpes/{cpeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Moves a CPE object into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: GetCpeDeviceConfigContent",
|
|
"api_call": "GET /cpes/{cpeId}/cpeConfigContent",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Renders a set of CPE configuration content that can help a network engineer configure the actual\nCPE device (for example, a hardware router) represented by the specified [Cpe](#/en/iaas/latest/Cpe/)\nobject.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) must have the CPE's device type specified by the `cpeDeviceShapeId`\nattribute. The content optionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for *all* of the\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/) objects that use the specified CPE.\nHere are similar operations:\n\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n returns CPE configuration content for all IPSec tunnels in a single IPSec connection.\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n returns CPE configuration content for a specific IPSec tunnel in an IPSec connection.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes: ListCpes",
|
|
"api_call": "GET /cpes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the customer-premises equipment objects (CPEs) in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes: CreateCpe",
|
|
"api_call": "POST /cpes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For\nmore information, see [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec\nconnection or other Networking Service components. If you're not sure which compartment to\nuse, put the CPE in the same compartment as the DRG. For more information about\ncompartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must provide the public IP address of your on-premises router. See\n[CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm).\n\nYou may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to\nbe unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: DeleteCrossConnectGroup",
|
|
"api_call": "DELETE /crossConnectGroups/{crossConnectGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Deletes the specified cross-connect group. It must not contain any\ncross-connects, and it cannot be mapped to a\n[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: GetCrossConnectGroups",
|
|
"api_call": "GET /crossConnectGroups/{crossConnectGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Gets the specified cross-connect group's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: UpdateCrossConnectGroup",
|
|
"api_call": "PUT /crossConnectGroups/{crossConnectGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Updates the specified cross-connect group's display name.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: ChangeCrossConnectGroupCompartment",
|
|
"api_call": "POST /crossConnectGroups/{crossConnectGroupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Moves a cross-connect group into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups: ListCrossConnectGroups",
|
|
"api_call": "GET /crossConnectGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the cross-connect groups in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups: CreateCrossConnectGroup",
|
|
"api_call": "POST /crossConnectGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new cross-connect group to use with Oracle Cloud Infrastructure\nFastConnect. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the cross-connect group to reside. If you're\nnot sure which compartment to use, put the cross-connect group in the\nsame compartment with your VCN. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the cross-connect group.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: DeleteCrossConnect",
|
|
"api_call": "DELETE /crossConnects/{crossConnectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Deletes the specified cross-connect. It must not be mapped to a\n[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: GetCrossConnect",
|
|
"api_call": "GET /crossConnects/{crossConnectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Gets the specified cross-connect's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: UpdateCrossConnect",
|
|
"api_call": "PUT /crossConnects/{crossConnectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Updates the specified cross-connect.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: ChangeCrossConnectCompartment",
|
|
"api_call": "POST /crossConnects/{crossConnectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Moves a cross-connect into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: GetCrossConnectLetterOfAuthority",
|
|
"api_call": "GET /crossConnects/{crossConnectId}/letterOfAuthority",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Gets the Letter of Authority for the specified cross-connect.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: GetCrossConnectStatus",
|
|
"api_call": "GET /crossConnects/{crossConnectId}/status",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Gets the status of the specified cross-connect.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects: ListCrossConnects",
|
|
"api_call": "GET /crossConnects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"crossConnectGroupId": "string: The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the cross-connects in the specified compartment. You can filter the list\nby specifying the [OCID](/Content/General/Concepts/identifiers.htm) of a cross-connect group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects: CreateCrossConnect",
|
|
"api_call": "POST /crossConnects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new cross-connect. Oracle recommends you create each cross-connect in a\n[CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation\nwith the connection.\n\nAfter creating the `CrossConnect` object, you need to go the FastConnect location\nand request to have the physical cable installed. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the cross-connect to reside. If you're\nnot sure which compartment to use, put the cross-connect in the\nsame compartment with your VCN. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the cross-connect.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: DeleteDedicatedVmHost",
|
|
"api_call": "DELETE /dedicatedVmHosts/{dedicatedVmHostId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Deletes the specified dedicated virtual machine host.\n\nIf any VM instances are assigned to the dedicated virtual machine host,\nthe delete operation will fail and the service will return a 409 response code.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: GetDedicatedVmHost",
|
|
"api_call": "GET /dedicatedVmHosts/{dedicatedVmHostId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Gets information about the specified dedicated virtual machine host.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: UpdateDedicatedVmHost",
|
|
"api_call": "PUT /dedicatedVmHosts/{dedicatedVmHostId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.\nIf an attribute value is not included, it will not be updated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: ChangeDedicatedVmHostCompartment",
|
|
"api_call": "POST /dedicatedVmHosts/{dedicatedVmHostId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Moves a dedicated virtual machine host from one compartment to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: ListDedicatedVmHostInstances",
|
|
"api_call": "GET /dedicatedVmHosts/{dedicatedVmHostId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts: ListDedicatedVmHosts",
|
|
"api_call": "GET /dedicatedVmHosts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"instanceShapeName": "string: The name for the instance's shape.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"remainingMemoryInGBsGreaterThanOrEqualTo": "number: The remaining memory of the dedicated VM host, in GBs.",
|
|
"remainingOcpusGreaterThanOrEqualTo": "number: The available OCPUs of the dedicated VM host."
|
|
},
|
|
"functionality": "Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.\n\nYou can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named\ndedicated virtual machine hosts in the compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts: CreateDedicatedVmHost",
|
|
"api_call": "POST /dedicatedVmHosts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.\nDedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers\nthat are a single tenant and not shared with other customers.\nFor more information, see [Dedicated Virtual Machine Hosts](/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: DeleteDhcpOptions",
|
|
"api_call": "DELETE /dhcps/{dhcpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a\nVCN's default set of DHCP options.\n\nThis is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily\nuntil the set is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: GetDhcpOptions",
|
|
"api_call": "GET /dhcps/{dhcpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Gets the specified set of DHCP options.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: UpdateDhcpOptions",
|
|
"api_call": "PUT /dhcps/{dhcpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Updates the specified set of DHCP options. You can update the display name or the options\nthemselves. Avoid entering confidential information.\n\nNote that the `options` object you provide replaces the entire existing set of options.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: ChangeDhcpOptionsCompartment",
|
|
"api_call": "POST /dhcps/{dhcpId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Moves a set of DHCP options into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps: ListDhcpOptions",
|
|
"api_call": "GET /dhcps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"vcnId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the sets of DHCP options in the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment.\nThe response includes the default set of options that automatically comes with each VCN,\nplus any other sets you've created.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps: CreateDhcpOptions",
|
|
"api_call": "POST /dhcps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new set of DHCP options for the specified VCN. For more information, see\n[DhcpOptions](#/en/iaas/latest/DhcpOptions/).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the set of\nDHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN,\nsubnets, or other Networking Service components. If you're not sure which compartment to use, put the set\nof DHCP options in the same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the set of DHCP options, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: DeleteDrgAttachment",
|
|
"api_call": "DELETE /drgAttachments/{drgAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Detaches a DRG from a network resource by deleting the corresponding `DrgAttachment` resource. This is an asynchronous\noperation. The attachment's `lifecycleState` will temporarily change to DETACHING until the attachment\nis completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: GetDrgAttachment",
|
|
"api_call": "GET /drgAttachments/{drgAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Gets the `DrgAttachment` resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: UpdateDrgAttachment",
|
|
"api_call": "PUT /drgAttachments/{drgAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Updates the display name and routing information for the specified `DrgAttachment`.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: RemoveExportDrgRouteDistribution",
|
|
"api_call": "POST /drgAttachments/{drgAttachmentId}/actions/removeExportDrgRouteDistribution",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Removes the export route distribution from the DRG attachment so no routes are advertised to it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments: ListDrgAttachments",
|
|
"api_call": "GET /drgAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"vcnId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.",
|
|
"drgId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"networkId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG.",
|
|
"attachmentType": "string: The type for the network resource attached to the DRG.",
|
|
"drgRouteTableId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to the DRG attachment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the `DrgAttachment` resource for the specified compartment. You can filter the\nresults by DRG, attached network, attachment type, DRG route table or\nVCN route table.\n\nThe LIST API lists DRG attachments by attachment type. It will default to list VCN attachments,\nbut you may request to list ALL attachments of ALL types. \n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments: CreateDrgAttachment",
|
|
"api_call": "POST /drgAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG\nat a time, but a DRG can be attached to more than one VCN. The response includes a `DrgAttachment`\nobject with its own [OCID](/Content/General/Concepts/identifiers.htm). For more information about DRGs, see\n[Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm).\n\nYou may optionally specify a *display name* for the attachment, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor the purposes of access control, the DRG attachment is automatically placed into the currently selected compartment.\nFor more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id} > actions: AddDrgRouteDistributionStatements",
|
|
"api_call": "POST /drgRouteDistributions/{drgRouteDistributionId}/actions/addDrgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Adds one or more route distribution statements to the specified route distribution.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id} > actions: RemoveDrgRouteDistributionStatements",
|
|
"api_call": "POST /drgRouteDistributions/{drgRouteDistributionId}/actions/removeDrgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Removes one or more route distribution statements from the specified route distribution's map.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id} > actions: UpdateDrgRouteDistributionStatements",
|
|
"api_call": "POST /drgRouteDistributions/{drgRouteDistributionId}/actions/updateDrgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Updates one or more route distribution statements in the specified route distribution.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: DeleteDrgRouteDistribution",
|
|
"api_call": "DELETE /drgRouteDistributions/{drgRouteDistributionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table.\n\nRemove the DRG route distribution from a DRG attachment or DRG route table by using the \"RemoveExportDrgRouteDistribution\" or \"RemoveImportDrgRouteDistribution' operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: GetDrgRouteDistribution",
|
|
"api_call": "GET /drgRouteDistributions/{drgRouteDistributionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Gets the specified route distribution's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: UpdateDrgRouteDistribution",
|
|
"api_call": "PUT /drgRouteDistributions/{drgRouteDistributionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Updates the specified route distribution\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: ListDrgRouteDistributionStatements",
|
|
"api_call": "GET /drgRouteDistributions/{drgRouteDistributionId}/drgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by.",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Lists the statements for the specified route distribution.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions: ListDrgRouteDistributionStatements",
|
|
"api_call": "GET /drgRouteDistributions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter that only returns resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the route distributions in the specified DRG.\n\nTo retrieve the statements in a distribution, use the\nListDrgRouteDistributionStatements operation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions: CreateDrgRouteDistribution",
|
|
"api_call": "POST /drgRouteDistributions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new route distribution for the specified DRG. \nAssign the route distribution as an import distribution to a DRG route table using the `UpdateDrgRouteTable` or `CreateDrgRouteTable` operations.\nAssign the route distribution as an export distribution to a DRG attachment\nusing the `UpdateDrgAttachment` or `CreateDrgAttachment` operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: AddDrgRouteRules",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/addDrgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Adds one or more static route rules to the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: RemoveDrgRouteRules",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/removeDrgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Removes one or more route rules from the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: RemoveImportDrgRouteDistribution",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/removeImportDrgRouteDistribution",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Removes the import route distribution from the DRG route table so no routes are imported\ninto it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: UpdateDrgRouteRules",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/updateDrgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Updates one or more route rules in the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: DeleteDrgRouteTable",
|
|
"api_call": "DELETE /drgRouteTables/{drgRouteTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Deletes the specified DRG route table. There must not be any DRG attachments assigned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: GetDrgRouteTable",
|
|
"api_call": "GET /drgRouteTables/{drgRouteTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Gets the specified DRG route table's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: UpdateDrgRouteTable",
|
|
"api_call": "PUT /drgRouteTables/{drgRouteTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Updates the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: ListDrgRouteRules",
|
|
"api_call": "GET /drgRouteTables/{drgRouteTableId}/drgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"routeType": "string: Static routes are specified through the DRG route table API.\nDynamic routes are learned by the DRG from the DRG attachments through various routing protocols.\n",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Lists the route rules in the specified DRG route table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables: ListDrgRouteTables",
|
|
"api_call": "GET /drgRouteTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"importDrgRouteDistributionId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution.\n",
|
|
"lifecycleState": "string: A filter that only returns matches for the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the DRG route tables for the specified DRG.\n\nUse the `ListDrgRouteRules` operation to retrieve the route rules in a table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables: CreateDrgRouteTable",
|
|
"api_call": "POST /drgRouteTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment\nusing the `UpdateDrgAttachment` or `CreateDrgAttachment` operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id} > actions: GetAllDrgAttachments",
|
|
"api_call": "POST /drgs/{drgId}/actions/getAllDrgAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"attachmentType": "string: The type for the network resource attached to the DRG.",
|
|
"isCrossTenancy": "boolean: Whether the DRG attachment lives in a different tenancy than the DRG.",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Returns a complete list of DRG attachments that belong to a particular DRG.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id} > actions: UpgradeDrg",
|
|
"api_call": "POST /drgs/{drgId}/actions/upgrade",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Upgrades the DRG. After upgrade, you can control routing inside your DRG\nvia DRG attachments, route distributions, and DRG route tables.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id} > actions: UpgradeStatus",
|
|
"api_call": "GET /drgs/{drgId}/actions/upgradeStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: DeleteDrg",
|
|
"api_call": "DELETE /drgs/{drgId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise\nnetwork. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous\noperation. The DRG's `lifecycleState` will change to TERMINATING temporarily until the DRG is completely\nremoved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: GetDrg",
|
|
"api_call": "GET /drgs/{drgId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Gets the specified DRG's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: UpdateDrg",
|
|
"api_call": "PUT /drgs/{drgId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Updates the specified DRG's display name or tags. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: GetDrgRedundancyStatus",
|
|
"api_call": "GET /drgs/{drgId}/redundancyStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Gets the redundancy status for the specified DRG. For more information, see\n[Redundancy Remedies](/iaas/Content/Network/Troubleshoot/drgredundancy.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs: ListDrgs",
|
|
"api_call": "GET /drgs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the DRGs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs: CreateDrg",
|
|
"api_call": "POST /drgs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information,\nsee [Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN,\nthe DRG attachment, or other Networking Service components. If you're not sure which compartment\nto use, put the DRG in the same compartment as the VCN. For more information about compartments\nand access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the DRG, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services > {provider Service Id}: GetFastConnectProviderService",
|
|
"api_call": "GET /fastConnectProviderServices/{providerServiceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"providerServiceId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service."
|
|
},
|
|
"functionality": "Gets the specified provider service.\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services > {provider Service Id}: GetFastConnectProviderServiceKey",
|
|
"api_call": "GET /fastConnectProviderServices/{providerServiceId}/providerServiceKeys/{providerServiceKeyName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"providerServiceId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service.",
|
|
"providerServiceKeyName": "[REQUIRED] string: (Required) The provider service key that the provider gives you when you set up a virtual circuit connection\nfrom the provider to Oracle Cloud Infrastructure. You can set up that connection and get your\nprovider service key at the provider's website or portal. For the portal location, see the `description`\nattribute of the [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/).\n"
|
|
},
|
|
"functionality": "Gets the specified provider service key's information. Use this operation to validate a\nprovider service key. An invalid key returns a 404 error.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services > {provider Service Id}: ListFastConnectProviderVirtualCircuitBandwidthShapes",
|
|
"api_call": "GET /fastConnectProviderServices/{providerServiceId}/virtualCircuitBandwidthShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"providerServiceId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service."
|
|
},
|
|
"functionality": "Gets the list of available virtual circuit bandwidth levels for a provider.\nYou need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit.\n\nFor more information about virtual circuits, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services: ListFastConnectProviderServices",
|
|
"api_call": "GET /fastConnectProviderServices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the service offerings from supported providers. You need this\ninformation so you can specify your desired provider and service\noffering when you create a virtual circuit.\n\nFor the compartment ID, provide the [OCID](/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).\n\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > actions: ChangeImageCompartment",
|
|
"api_call": "POST /images/{imageId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Moves an image into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > actions: ExportImage",
|
|
"api_call": "POST /images/{imageId}/actions/export",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL,\nor the namespace, bucket name, and object name when specifying the location to export to.\n\nFor more information about exporting images, see [Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm).\n\nTo perform an image export, you need write access to the Object Storage bucket for the image,\nsee [Let Users Write Objects to Object Storage Buckets](/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4).\n\nSee [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm)\nfor constructing URLs for image import/export.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes > {shape Name}: RemoveImageShapeCompatibilityEntry",
|
|
"api_call": "DELETE /images/{imageId}/shapes/{shapeName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.",
|
|
"shapeName": "[REQUIRED] string: (Required) Shape name."
|
|
},
|
|
"functionality": "Removes a shape from the compatible shapes list for the image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes > {shape Name}: GetImageShapeCompatibilityEntry",
|
|
"api_call": "GET /images/{imageId}/shapes/{shapeName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.",
|
|
"shapeName": "[REQUIRED] string: (Required) Shape name."
|
|
},
|
|
"functionality": "Retrieves an image shape compatibility entry.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes > {shape Name}: AddImageShapeCompatibilityEntry",
|
|
"api_call": "PUT /images/{imageId}/shapes/{shapeName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.",
|
|
"shapeName": "[REQUIRED] string: (Required) Shape name."
|
|
},
|
|
"functionality": "Adds a shape to the compatible shapes list for the image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes: ListImageShapeCompatibilityEntries",
|
|
"api_call": "GET /images/{imageId}/shapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Lists the compatible shapes for the specified image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id}: DeleteImage",
|
|
"api_call": "DELETE /images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Deletes an image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id}: GetImage",
|
|
"api_call": "GET /images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Gets the specified image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id}: UpdateImage",
|
|
"api_call": "PUT /images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Updates the display name of the image. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images: ListImages",
|
|
"api_call": "GET /images",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists a subset of images available in the specified compartment, including\n[platform images](/iaas/Content/Compute/References/images.htm) and\n[custom images](/iaas/Content/Compute/Tasks/managingcustomimages.htm). \nThe list of platform images includes the three most recently published versions \nof each major distribution.\n\nThe list of images returned is ordered to first show the recent platform images,\nthen all of the custom images.\n\n**Caution:** Platform images are refreshed regularly. When new images are released, older versions are replaced. \nThe image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images: CreateImage",
|
|
"api_call": "POST /images",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.\n\nWhen creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and\nthe OCID of the compartment containing that instance. For more information about images,\nsee [Managing Custom Images](/iaas/Content/Compute/Tasks/managingcustomimages.htm).\n\nWhen importing an exported image from Object Storage, you specify the source information\nin [ImageSourceDetails](#/en/iaas/latest/requests/ImageSourceDetails).\n\nWhen importing an image based on the namespace, bucket name, and object name,\nuse [ImageSourceViaObjectStorageTupleDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageTupleDetails).\n\nWhen importing an image based on the Object Storage URL, use\n[ImageSourceViaObjectStorageUriDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageUriDetails).\nSee [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm)\nfor constructing URLs for image import/export.\n\nFor more information about importing exported images, see\n[Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm).\n\nYou may optionally specify a *display name* for the image, which is simply a friendly name or description.\nIt does not have to be unique, and you can change it. See [UpdateImage](#/en/iaas/latest/Image/UpdateImage).\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id} > actions: ChangeInstanceConfigurationCompartment",
|
|
"api_call": "POST /instanceConfigurations/{instanceConfigurationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Moves an instance configuration into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance configuration to a different compartment, associated resources such as\ninstance pools are not moved.\n\n**Important:** Most of the properties for an existing instance configuration, including the compartment,\ncannot be modified after you create the instance configuration. Although you can move an instance configuration\nto a different compartment, you will not be able to use the instance configuration to manage instance pools\nin the new compartment. If you want to update an instance configuration to point to a different compartment,\nyou should instead create a new instance configuration in the target compartment using\n[CreateInstanceConfiguration](/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id} > actions: LaunchInstanceConfiguration",
|
|
"api_call": "POST /instanceConfigurations/{instanceConfigurationId}/actions/launch",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Launches an instance from an instance configuration.\n\nIf the instance configuration does not include all of the parameters that are\nrequired to launch an instance, such as the availability domain and subnet ID, you must\nprovide these parameters when you launch an instance from the instance configuration.\nFor more information, see the [InstanceConfiguration](#/en/iaas/latest/InstanceConfiguration/)\nresource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id}: DeleteInstanceConfiguration",
|
|
"api_call": "DELETE /instanceConfigurations/{instanceConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Deletes an instance configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id}: GetInstanceConfiguration",
|
|
"api_call": "GET /instanceConfigurations/{instanceConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Gets the specified instance configuration",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id}: UpdateInstanceConfiguration",
|
|
"api_call": "PUT /instanceConfigurations/{instanceConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Updates the free-form tags, defined tags, and display name of an instance configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations: ListInstanceConfigurations",
|
|
"api_call": "GET /instanceConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the instance configurations in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations: CreateInstanceConfiguration",
|
|
"api_call": "POST /instanceConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates an instance configuration. An instance configuration is a template that defines the\nsettings to use when creating Compute instances.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections > {instance Console Connection Id}: DeleteInstanceConsoleConnection",
|
|
"api_call": "DELETE /instanceConsoleConnections/{instanceConsoleConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleConnectionId": "[REQUIRED] string: (Required) The OCID of the instance console connection."
|
|
},
|
|
"functionality": "Deletes the specified instance console connection.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections > {instance Console Connection Id}: GetInstanceConsoleConnection",
|
|
"api_call": "GET /instanceConsoleConnections/{instanceConsoleConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleConnectionId": "[REQUIRED] string: (Required) The OCID of the instance console connection."
|
|
},
|
|
"functionality": "Gets the specified instance console connection's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections > {instance Console Connection Id}: UpdateInstanceConsoleConnection",
|
|
"api_call": "PUT /instanceConsoleConnections/{instanceConsoleConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConsoleConnectionId": "[REQUIRED] string: (Required) The OCID of the instance console connection."
|
|
},
|
|
"functionality": "Updates the defined tags and free-form tags for the specified instance console connection.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections: ListInstanceConsoleConnections",
|
|
"api_call": "GET /instanceConsoleConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the console connections for the specified compartment or instance.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections: CreateInstanceConsoleConnection",
|
|
"api_call": "POST /instanceConsoleConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new console connection to the specified instance.\nAfter the console connection has been created and is available,\nyou connect to the console using SSH.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: DeleteConsoleHistory",
|
|
"api_call": "DELETE /instanceConsoleHistories/{instanceConsoleHistoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Deletes the specified console history metadata and the console history data.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: GetConsoleHistory",
|
|
"api_call": "GET /instanceConsoleHistories/{instanceConsoleHistoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Shows the metadata for the specified console history.\nSee [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)\nfor details about using the console history operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: UpdateConsoleHistory",
|
|
"api_call": "PUT /instanceConsoleHistories/{instanceConsoleHistoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Updates the specified console history metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: GetConsoleHistoryContent",
|
|
"api_call": "GET /instanceConsoleHistories/{instanceConsoleHistoryId}/data",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"offset": "integer: Offset of the snapshot data to retrieve.",
|
|
"length": "integer: Length of the snapshot data to retrieve.",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Gets the actual console history data (not the metadata).\nSee [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)\nfor details about using the console history operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories: ListConsoleHistories",
|
|
"api_call": "GET /instanceConsoleHistories/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the console history metadata for the specified compartment or instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories: CaptureConsoleHistory",
|
|
"api_call": "POST /instanceConsoleHistories/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Captures the most recent serial console data (up to a megabyte) for the\nspecified instance.\n\nThe `CaptureConsoleHistory` operation works with the other console history operations\nas described below.\n\n1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the\nmost recent console history. This call returns a `ConsoleHistory`\nobject. The object will have a state of REQUESTED.\n2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with\nthe identifier of the console history metadata. The state of the\n`ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and\nthen SUCCEEDED (or FAILED).\n3. Use `GetConsoleHistoryContent` to get the actual console history data (not the\nmetadata).\n4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata\nand the console history data.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: AttachLoadBalancer",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/attachLoadBalancer",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Attach a load balancer to the instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: ChangeInstancePoolCompartment",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Moves an instance pool into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance pool to a different compartment, associated resources such as the instances in\nthe pool, boot volumes, VNICs, and autoscaling configurations are not moved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: DetachInstancePoolInstance",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/detachInstance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Detaches an instance from an instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: DetachLoadBalancer",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/detachLoadBalancer",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Detach a load balancer from the instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: ResetInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/reset",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the reset (immediate power off and power on) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: SoftresetInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/softreset",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the softreset (ACPI shutdown and power on) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n\nSoftreset gracefully reboots the instances by sending a shutdown command to the operating systems.\nAfter waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: StartInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the start (power on) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: StopInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the stop (immediate power off) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > instances: ListInstancePoolInstances",
|
|
"api_call": "GET /instancePools/{instancePoolId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "List the instances in the specified instance pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > instances: AttachInstancePoolInstance",
|
|
"api_call": "POST /instancePools/{instancePoolId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Attaches an instance to an instance pool. For information about the prerequisites\nthat an instance must meet before you can attach it to a pool, see\n[Attaching an Instance to an Instance Pool](/iaas/Content/Compute/Tasks/updatinginstancepool.htm#attach-instance).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > instances: GetInstancePoolInstance",
|
|
"api_call": "GET /instancePools/{instancePoolId}/instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets information about an instance that belongs to an instance pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: TerminateInstancePool",
|
|
"api_call": "DELETE /instancePools/{instancePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Terminate the specified instance pool.\n\n**Warning:** When you delete an instance pool, the resources that were created by the pool are permanently\ndeleted, including associated instances, attached boot volumes, and block volumes.\n\nIf an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted\nasynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using\nthe `DeleteAutoScalingConfiguration` operation in the Autoscaling API.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: GetInstancePool",
|
|
"api_call": "GET /instancePools/{instancePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Gets the specified instance pool",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: UpdateInstancePool",
|
|
"api_call": "PUT /instancePools/{instancePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Update the specified instance pool.\n\nThe OCID of the instance pool remains the same.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: GetLoadBalancerAttachment",
|
|
"api_call": "GET /instancePools/{instancePoolId}/loadBalancerAttachments/{instancePoolLoadBalancerAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.",
|
|
"instancePoolLoadBalancerAttachmentId": "[REQUIRED] string: (Required) The OCID of the load balancer attachment."
|
|
},
|
|
"functionality": "Gets information about a load balancer that is attached to the specified instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools: ListInstancePools",
|
|
"api_call": "GET /instancePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the instance pools in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools: CreateInstancePool",
|
|
"api_call": "POST /instancePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create an instance pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id} > actions: AcceptShieldedIntegrityPolicy",
|
|
"api_call": "POST /instances/{instanceId}/actions/acceptShieldedIntegrityPolicy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Accept the changes to the PCR values in the measured boot report.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id} > actions: ChangeInstanceCompartment",
|
|
"api_call": "POST /instances/{instanceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Moves an instance into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance to a different compartment, associated resources such as boot volumes and VNICs\nare not moved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: TerminateInstance",
|
|
"api_call": "DELETE /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"preserveBootVolume": "boolean: Specifies whether to delete or preserve the boot volume when terminating an instance.\nWhen set to `true`, the boot volume is preserved. The default value is `false`.\n",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Terminates the specified instance. Any attached VNICs and volumes are automatically detached\nwhen the instance terminates.\n\nTo preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`.\nTo delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`.\n\nThis is an asynchronous operation. The instance's `lifecycleState` will change to TERMINATING temporarily\nuntil the instance is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetInstance",
|
|
"api_call": "GET /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets information about the specified instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: InstanceAction",
|
|
"api_call": "POST /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"Content-Type": "string",
|
|
"action": "string: (Required) The action to perform on the instance.",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Performs one of the following power actions on the specified instance:\n\n- **START** - Powers on the instance.\n\n- **STOP** - Powers off the instance.\n\n- **RESET** - Powers off the instance and then powers it back on.\n\n- **SOFTSTOP** - Gracefully shuts down the instance by sending a shutdown command to the operating system.\nAfter waiting 15 minutes for the OS to shut down, the instance is powered off.\nIf the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting\nin data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the\ninstance.\n\n- **SOFTRESET** - Gracefully reboots the instance by sending a shutdown command to the operating system.\nAfter waiting 15 minutes for the OS to shut down, the instance is powered off and\nthen powered back on.\n\n- **SENDDIAGNOSTICINTERRUPT** - For advanced users. **Warning: Sending a diagnostic interrupt to a live system can\ncause data corruption or system failure.** Sends a diagnostic interrupt that causes the instance's\nOS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a\ncrash dump file when it crashes. The crash dump captures information about the state of the OS at the time of\nthe crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see\n[Sending a Diagnostic Interrupt](/iaas/Content/Compute/Tasks/sendingdiagnosticinterrupt.htm).\n\n\nFor more information about managing instance lifecycle states, see\n[Stopping and Starting an Instance](/iaas/Content/Compute/Tasks/restartinginstance.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: UpdateInstance",
|
|
"api_call": "PUT /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Updates certain fields on the specified instance. Fields that are not provided in the\nrequest will not be updated. Avoid entering confidential information.\n\nChanges to metadata fields will be reflected in the instance metadata service (this may take\nup to a minute).\n\nThe OCID of the instance remains the same.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetInstanceDefaultCredentials",
|
|
"api_call": "GET /instances/{instanceId}/defaultCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.\nFor certain operating systems, users will be forced to change the initial credentials.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: ListInstanceDevices",
|
|
"api_call": "GET /instances/{instanceId}/devices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"isAvailable": "boolean: A filter to return only available devices or only used devices.\n",
|
|
"name": "string: A filter to return only devices that match the given name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets a list of all the devices for given instance. You can optionally filter results by device availability.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetWindowsInstanceInitialCredentials",
|
|
"api_call": "GET /instances/{instanceId}/initialCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Deprecated. Use [GetInstanceDefaultCredentials](#/en/iaas/latest/InstanceCredentials/GetInstanceDefaultCredentials) instead.\n\nGets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.\nFor certain operating systems, users will be forced to change the initial credentials.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetMeasuredBootReport",
|
|
"api_call": "GET /instances/{instanceId}/measuredBootReport",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets the measured boot report for this shielded instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances: ListInstances",
|
|
"api_call": "GET /instances/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the instances in the specified compartment and the specified availability domain.\nYou can filter the results by specifying an instance name (the list will include all the identically-named\ninstances in the compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances: LaunchInstance",
|
|
"api_call": "POST /instances/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new instance in the specified compartment and the specified availability domain.\nFor general information about instances, see\n[Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm).\n\nFor information about access control and compartments, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nFor information about availability domains, see\n[Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).\nTo get a list of availability domains, use the `ListAvailabilityDomains` operation\nin the Identity and Access Management Service API.\n\nAll Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned,\nunique ID called an Oracle Cloud Identifier (OCID).\nWhen you create a resource, you can find its OCID in the response. You can\nalso retrieve a resource's OCID by using a List API operation\non that resource type, or by viewing the resource in the Console.\n\nTo launch an instance using an image or a boot volume use the `sourceDetails` parameter in [LaunchInstanceDetails](#/en/iaas/latest/LaunchInstanceDetails).\n\nWhen you launch an instance, it is automatically attached to a virtual\nnetwork interface card (VNIC), called the *primary VNIC*. The VNIC\nhas a private IP address from the subnet's CIDR. You can either assign a\nprivate IP address of your choice or let Oracle automatically assign one.\nYou can choose whether the instance has a public IP address. To retrieve the\naddresses, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation to get the VNIC ID for the instance, and then call\n[GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID.\n\nYou can later add secondary VNICs to an instance. For more information, see\n[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).\n\nTo launch an instance from a Marketplace image listing, you must provide the image ID of the\nlisting resource version that you want, but you also must subscribe to the listing before you try\nto launch the instance. To subscribe to the listing, use the [GetAppCatalogListingAgreements](#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements)\noperation to get the signature for the terms of use agreement for the desired listing resource version.\nThen, call [CreateAppCatalogSubscription](#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription)\nwith the signature. To get the image ID for the LaunchInstance operation, call\n[GetAppCatalogListingResourceVersion](#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: DeleteInternetGateway",
|
|
"api_call": "DELETE /internetGateways/{igId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Deletes the specified internet gateway. The internet gateway does not have to be disabled, but\nthere must not be a route table that lists it as a target.\n\nThis is an asynchronous operation. The gateway's `lifecycleState` will change to TERMINATING temporarily\nuntil the gateway is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: GetInternetGateway",
|
|
"api_call": "GET /internetGateways/{igId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Gets the specified internet gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: UpdateInternetGateway",
|
|
"api_call": "PUT /internetGateways/{igId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Updates the specified internet gateway. You can disable/enable it, or change its display name\nor tags. Avoid entering confidential information.\n\nIf the gateway is disabled, that means no traffic will flow to/from the internet even if there's\na route rule that enables that traffic.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: ChangeInternetGatewayCompartment",
|
|
"api_call": "POST /internetGateways/{igId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Moves an internet gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways: ListInternetGateways",
|
|
"api_call": "GET /internetGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the internet gateways in the specified VCN and the specified compartment.\nIf the VCN ID is not provided, then the list includes the internet gateways from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways: CreateInternetGateway",
|
|
"api_call": "POST /internetGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new internet gateway for the specified VCN. For more information, see\n[Access to the Internet](/iaas/Content/Network/Tasks/managingIGs.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the Internet\nGateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or\nother Networking Service components. If you're not sure which compartment to use, put the Internet\nGateway in the same compartment with the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nYou may optionally specify a *display name* for the internet gateway, otherwise a default is provided. It\ndoes not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in\nthe subnet's route table (for example, 0.0.0.0/0 > internet gateway). See\n[UpdateRouteTable](#/en/iaas/latest/RouteTable/UpdateRouteTable).\n\nYou must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no\ntraffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later\nuse [UpdateInternetGateway](#/en/iaas/latest/InternetGateway/UpdateInternetGateway) to easily disable/enable\nthe gateway without changing the route rule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > shared Secret: GetIPSecConnectionTunnelSharedSecret",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Gets the specified tunnel's shared secret (pre-shared key). To get other information\nabout the tunnel, use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > shared Secret: UpdateIPSecConnectionTunnelSharedSecret",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Updates the shared secret (pre-shared key) for the specified tunnel.\n\n**Important:** If you change the shared secret, the tunnel will go down while it's reprovisioned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > tunnel Device Config: GetTunnelCpeDeviceConfig",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Gets the set of CPE configuration answers for the tunnel, which the customer provided in\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig).\nTo get the full set of content for the tunnel (any answers merged with the template of other\ninformation specific to the CPE device type), use\n[GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > tunnel Device Config: UpdateTunnelCpeDeviceConfig",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Creates or updates the set of CPE configuration answers for the specified tunnel.\nThe answers correlate to the questions that are specific to the CPE device type (see the\n`parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > tunnel Device Config: GetTunnelCpeDeviceConfigContent",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a\nnetwork engineer configure the actual CPE device (for example, a hardware router) that the specified\nIPSec tunnel terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content\noptionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for only the specified IPSec tunnel.\nHere are other similar operations:\n\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n returns CPE configuration content for all tunnels in a single IPSec connection.\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n returns CPE configuration content for *all* IPSec connections that use a specific CPE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id}: GetIPSecConnectionTunnel",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Gets the specified tunnel's information. The resulting object does not include the tunnel's\nshared secret (pre-shared key). To retrieve that, use\n[GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id}: UpdateIPSecConnectionTunnelDetails",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}/tunnels/{tunnelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Updates the specified tunnel. This operation lets you change tunnel attributes such as the\nrouting type (BGP dynamic routing or static routing). Here are some important notes:\n\n * If you change the tunnel's routing type or BGP session configuration, the tunnel will go\n down while it's reprovisioned.\n\n * If you want to switch the tunnel's `routing` from `STATIC` to `BGP`, make sure the tunnel's\n BGP session configuration attributes have been set ([bgpSessionConfig](#/en/iaas/latest/datatypes/BgpSessionInfo)).\n\n * If you want to switch the tunnel's `routing` from `BGP` to `STATIC`, make sure the\n [IPSecConnection](#/en/iaas/latest/IPSecConnection/) already has at least one valid CIDR\n static route.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels: ListIPSecConnectionTunnels",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Lists the tunnel information for the specified IPSec connection.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: DeleteIPSecConnection",
|
|
"api_call": "DELETE /ipsecConnections/{ipscId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and\non-premises network, it's easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact.\nIf you were to delete all the components and then later need to create an Site-to-Site VPN again, you would\nneed to configure your on-premises router again with the new information returned from\n[CreateIPSecConnection](#/en/iaas/latest/IPSecConnection/CreateIPSecConnection).\n\nThis is an asynchronous operation. The connection's `lifecycleState` will change to TERMINATING temporarily\nuntil the connection is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIPSecConnection",
|
|
"api_call": "GET /ipsecConnections/{ipscId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Gets the specified IPSec connection's basic information, including the static routes for the\non-premises router. If you want the status of the connection (whether it's up or down), use\n[GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: UpdateIPSecConnection",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Updates the specified IPSec connection.\n\nTo update an individual IPSec tunnel's attributes, use\n[UpdateIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/UpdateIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: ChangeIPSecConnectionCompartment",
|
|
"api_call": "POST /ipsecConnections/{ipscId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Moves an IPSec connection into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIpsecCpeDeviceConfigContent",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/cpeConfigContent",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Renders a set of CPE configuration content for the specified IPSec connection (for all the\ntunnels in the connection). The content helps a network engineer configure the actual CPE\ndevice (for example, a hardware router) that the specified IPSec connection terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content\noptionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for all tunnels in the single specified\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/) object. Here are other similar\noperations:\n\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n returns CPE configuration content for a specific tunnel within an IPSec connection.\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n returns CPE configuration content for *all* IPSec connections that use a specific CPE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIPSecConnectionDeviceConfig",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/deviceConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Deprecated. To get tunnel information, instead use:\n\n* [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel)\n* [GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIPSecConnectionDeviceStatus",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/deviceStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Deprecated. To get the tunnel status, instead use\n[GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections: ListIPSecConnections",
|
|
"api_call": "GET /ipsecConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the IPSec connections for the specified compartment. You can filter the\nresults by DRG or CPE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections: CreateIPSecConnection",
|
|
"api_call": "POST /ipsecConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new IPSec connection between the specified DRG and CPE. For more information, see\n[Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nIf you configure at least one tunnel to use static routing, then in the request you must provide\nat least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16.\nIf you configure both tunnels to use BGP dynamic routing, you can provide an empty list for\nthe static routes. For more information, see the important note in\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the\nIPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment\nas the DRG, CPE, or other Networking Service components. If you're not sure which compartment to\nuse, put the IPSec connection in the same compartment as the DRG. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nYou may optionally specify a *display name* for the IPSec connection, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nAfter creating the IPSec connection, you need to configure your on-premises router\nwith tunnel-specific information. For tunnel status and the required configuration information, see:\n\n * [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)\n * [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/)\n\nFor each tunnel, you need the IP address of Oracle's VPN headend and the shared secret\n(that is, the pre-shared key). For more information, see\n[CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6 > {ipv6Id}: DeleteIpv6",
|
|
"api_call": "DELETE /ipv6/{ipv6Id}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipv6Id": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6."
|
|
},
|
|
"functionality": "Unassigns and deletes the specified IPv6. You must specify the object's [OCID](/Content/General/Concepts/identifiers.htm).\nThe IPv6 address is returned to the subnet's pool of available addresses.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6 > {ipv6Id}: GetIpv6",
|
|
"api_call": "GET /ipv6/{ipv6Id}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipv6Id": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6."
|
|
},
|
|
"functionality": "Gets the specified IPv6. You must specify the object's [OCID](/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListIpv6s](#/en/iaas/latest/Ipv6/ListIpv6s)\nwith the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6 > {ipv6Id}: UpdateIpv6",
|
|
"api_call": "PUT /ipv6/{ipv6Id}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipv6Id": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6."
|
|
},
|
|
"functionality": "Updates the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n * Move an IPv6 to a different VNIC in the same subnet.\n * Enable/disable internet access for an IPv6.\n * Change the display name for an IPv6.\n * Update resource tags for an IPv6.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6: ListIpv6s",
|
|
"api_call": "GET /ipv6",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"ipAddress": "string: An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n",
|
|
"subnetId": "string: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet.",
|
|
"vnicId": "string: The OCID of the VNIC."
|
|
},
|
|
"functionality": "Lists the [IPv6](#/en/iaas/latest/Ipv6/) objects based\non one of these filters:\n\n * Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * Both IPv6 address and subnet OCID: This lets you get an `Ipv6` object based on its private\n IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetIpv6](#/en/iaas/latest/Ipv6/GetIpv6) requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6: CreateIpv6",
|
|
"api_call": "POST /ipv6",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates an IPv6 for the specified VNIC.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id} > actions: ChangeLocalPeeringGatewayCompartment",
|
|
"api_call": "POST /localPeeringGateways/{localPeeringGatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Moves a local peering gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id} > actions: ConnectLocalPeeringGateways",
|
|
"api_call": "POST /localPeeringGateways/{localPeeringGatewayId}/actions/connect",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Connects this local peering gateway (LPG) to another one in the same region.\n\nThis operation must be called by the VCN administrator who is designated as\nthe *requestor* in the peering relationship. The *acceptor* must implement\nan Identity and Access Management (IAM) policy that gives the requestor permission\nto connect to LPGs in the acceptor's compartment. Without that permission, this\noperation will fail. For more information, see\n[VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id}: DeleteLocalPeeringGateway",
|
|
"api_call": "DELETE /localPeeringGateways/{localPeeringGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Deletes the specified local peering gateway (LPG).\n\nThis is an asynchronous operation; the local peering gateway's `lifecycleState` changes to TERMINATING temporarily\nuntil the local peering gateway is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id}: GetLocalPeeringGateway",
|
|
"api_call": "GET /localPeeringGateways/{localPeeringGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Gets the specified local peering gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id}: UpdateLocalPeeringGateway",
|
|
"api_call": "PUT /localPeeringGateways/{localPeeringGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Updates the specified local peering gateway (LPG).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways: ListLocalPeeringGateways",
|
|
"api_call": "GET /localPeeringGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"vcnId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Lists the local peering gateways (LPGs) for the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways: CreateLocalPeeringGateway",
|
|
"api_call": "POST /localPeeringGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new local peering gateway (LPG) for the specified VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: DeleteNatGateway",
|
|
"api_call": "DELETE /natGateways/{natGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there\nmust not be a route rule that lists the NAT gateway as a target.\n\nThis is an asynchronous operation. The NAT gateway's `lifecycleState` will change to\nTERMINATING temporarily until the NAT gateway is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: GetNatGateway",
|
|
"api_call": "GET /natGateways/{natGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Gets the specified NAT gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: UpdateNatGateway",
|
|
"api_call": "PUT /natGateways/{natGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Updates the specified NAT gateway.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: ChangeNatGatewayCompartment",
|
|
"api_call": "POST /natGateways/{natGatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Moves a NAT gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways: ListNatGateways",
|
|
"api_call": "GET /natGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID\nto filter the results by VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways: CreateNatGateway",
|
|
"api_call": "POST /natGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the\nNAT gateway as the rule's target. See [Route Table](#/en/iaas/latest/RouteTable/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: AddNetworkSecurityGroupSecurityRules",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/addSecurityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Adds one or more security rules to the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: ChangeNetworkSecurityGroupCompartment",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Moves a network security group into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: RemoveNetworkSecurityGroupSecurityRules",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/removeSecurityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Removes one or more security rules from the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: UpdateNetworkSecurityGroupSecurityRules",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/updateSecurityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Updates one or more security rules in the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: DeleteNetworkSecurityGroup",
|
|
"api_call": "DELETE /networkSecurityGroups/{networkSecurityGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Deletes the specified network security group. The group must not contain any VNICs.\n\nTo get a list of the VNICs in a network security group, use\n[ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics).\nEach returned [NetworkSecurityGroupVnic](#/en/iaas/latest/NetworkSecurityGroupVnic/) object\ncontains both the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC and the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC's parent resource (for example,\nthe Compute instance that the VNIC is attached to).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: GetNetworkSecurityGroup",
|
|
"api_call": "GET /networkSecurityGroups/{networkSecurityGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Gets the specified network security group's information.\n\nTo list the VNICs in an NSG, see\n[ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics).\n\nTo list the security rules in an NSG, see\n[ListNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/ListNetworkSecurityGroupSecurityRules).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: UpdateNetworkSecurityGroup",
|
|
"api_call": "PUT /networkSecurityGroups/{networkSecurityGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Updates the specified network security group.\n\nTo add or remove an existing VNIC from the group, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n\nTo add a VNIC to the group *when you create the VNIC*, specify the NSG's [OCID](/iaas/Content/General/Concepts/identifiers.htm) during creation.\nFor example, see the `nsgIds` attribute in [CreateVnicDetails](#/en/iaas/latest/datatypes/CreateVnicDetails).\n\nTo add or remove security rules from the group, use\n[AddNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/AddNetworkSecurityGroupSecurityRules)\nor\n[RemoveNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/RemoveNetworkSecurityGroupSecurityRules).\n\nTo edit the contents of existing security rules in the group, use\n[UpdateNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/UpdateNetworkSecurityGroupSecurityRules).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: ListNetworkSecurityGroupSecurityRules",
|
|
"api_call": "GET /networkSecurityGroups/{networkSecurityGroupId}/securityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"direction": "string: Direction of the security rule. Set to `EGRESS` for rules that allow outbound IP packets,\nor `INGRESS` for rules that allow inbound IP packets.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by.",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Lists the security rules in the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: ListNetworkSecurityGroupVnics",
|
|
"api_call": "GET /networkSecurityGroups/{networkSecurityGroupId}/vnics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by.",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Lists the VNICs in the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups: ListNetworkSecurityGroups",
|
|
"api_call": "GET /networkSecurityGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists either the network security groups in the specified compartment, or those associated with the specified VLAN.\nYou must specify either a `vlanId` or a `compartmentId`, but not both. If you specify a `vlanId`, all other parameters are ignored.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups: CreateNetworkSecurityGroup",
|
|
"api_call": "POST /networkSecurityGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new network security group for the specified VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips > {private Ip Id}: DeletePrivateIp",
|
|
"api_call": "DELETE /privateIps/{privateIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"privateIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
|
|
},
|
|
"functionality": "Unassigns and deletes the specified private IP. You must\nspecify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The private IP address is returned to\nthe subnet's pool of available addresses.\n\nThis operation cannot be used with primary private IPs, which are\nautomatically unassigned and deleted when the VNIC is terminated.\n\n**Important:** If a secondary private IP is the\n[target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),\nunassigning it from the VNIC causes that route rule to blackhole and the traffic\nwill be dropped.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips > {private Ip Id}: GetPrivateIp",
|
|
"api_call": "GET /privateIps/{privateIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"privateIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
|
|
},
|
|
"functionality": "Gets the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps)\nwith the private IP address (for example, 10.0.3.3) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips > {private Ip Id}: UpdatePrivateIp",
|
|
"api_call": "PUT /privateIps/{privateIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"privateIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
|
|
},
|
|
"functionality": "Updates the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n - Move a secondary private IP to a different VNIC in the same subnet.\n - Change the display name for a secondary private IP.\n - Change the hostname for a secondary private IP.\n\nThis operation cannot be used with primary private IPs.\nTo update the hostname for the primary IP on a VNIC, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips: ListPrivateIps",
|
|
"api_call": "GET /privateIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"ipAddress": "string: An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n",
|
|
"subnetId": "string: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet.",
|
|
"vnicId": "string: The OCID of the VNIC.",
|
|
"vlanId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Lists the [PrivateIp](#/en/iaas/latest/PrivateIp/) objects based\non one of these filters:\n\n - Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - Both private IP address and subnet OCID: This lets\n you get a `privateIP` object based on its private IP\n address (for example, 10.0.3.3) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp)\n requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nIf you're listing all the private IPs associated with a given subnet\nor VNIC, the response includes both primary and secondary private IPs.\n\nIf you are an Oracle Cloud VMware Solution customer and have VLANs\nin your VCN, you can filter the list by VLAN [OCID](/iaas/Content/General/Concepts/identifiers.htm). See [Vlan](#/en/iaas/latest/Vlan).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips: CreatePrivateIp",
|
|
"api_call": "POST /privateIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a secondary private IP for the specified VNIC.\nFor more information about secondary private IPs, see\n[IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id} > actions: AddPublicIpPoolCapacity",
|
|
"api_call": "POST /publicIpPools/{publicIpPoolId}/actions/addCapacity",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Adds some or all of a CIDR block to a public IP pool.\n\nThe CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id} > actions: ChangePublicIpPoolCompartment",
|
|
"api_call": "POST /publicIpPools/{publicIpPoolId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Moves a public IP pool to a different compartment. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id} > actions: RemovePublicIpPoolCapacity",
|
|
"api_call": "POST /publicIpPools/{publicIpPoolId}/actions/removeCapacity",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Removes a CIDR block from the referenced public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id}: DeletePublicIpPool",
|
|
"api_call": "DELETE /publicIpPools/{publicIpPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Deletes the specified public IP pool.\nTo delete a public IP pool it must not have any active IP address allocations.\nYou must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm) when deleting an IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id}: GetPublicIpPool",
|
|
"api_call": "GET /publicIpPools/{publicIpPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Gets the specified `PublicIpPool` object. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id}: UpdatePublicIpPool",
|
|
"api_call": "PUT /publicIpPools/{publicIpPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Updates the specified public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools: ListPublicIpPools",
|
|
"api_call": "GET /publicIpPools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Lists the public IP pools in the specified compartment.\nYou can filter the list using query parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools: CreatePublicIpPool",
|
|
"api_call": "POST /publicIpPools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > actions: GetPublicIpByIpAddress",
|
|
"api_call": "POST /publicIps/actions/getByIpAddress",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Gets the public IP based on the public IP address (for example, 203.0.113.2).\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, the service returns the public IP object with\n`lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > actions: GetPublicIpByPrivateIpId",
|
|
"api_call": "POST /publicIps/actions/getByPrivateIpId",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Gets the public IP assigned to the specified private IP. You must specify the OCID\nof the private IP. If no public IP is assigned, a 404 is returned.\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, and you provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the original private\nIP, this operation returns a 404. If you instead provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target\nprivate IP, or if you instead call\n[GetPublicIp](#/en/iaas/latest/PublicIp/GetPublicIp) or\n[GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress), the\nservice returns the public IP object with `lifecycleState` = ASSIGNING and\n`assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: DeletePublicIp",
|
|
"api_call": "DELETE /publicIps/{publicIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Unassigns and deletes the specified public IP (either ephemeral or reserved).\nYou must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The public IP address is returned to the\nOracle Cloud Infrastructure public IP pool.\n\n**Note:** You cannot update, unassign, or delete the public IP that Oracle automatically\nassigned to an entity for you (such as a load balancer or NAT gateway). The public IP is\nautomatically deleted if the assigned entity is terminated.\n\nFor an assigned reserved public IP, the initial unassignment portion of this operation\nis asynchronous. Poll the public IP's `lifecycleState` to determine\nif the operation succeeded.\n\nIf you want to simply unassign a reserved public IP and return it to your pool\nof reserved public IPs, instead use\n[UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: GetPublicIp",
|
|
"api_call": "GET /publicIps/{publicIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Gets the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nAlternatively, you can get the object by using [GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress)\nwith the public IP address (for example, 203.0.113.2).\n\nOr you can use [GetPublicIpByPrivateIpId](#/en/iaas/latest/PublicIp/GetPublicIpByPrivateIpId)\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is assigned to.\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, the service returns the public IP object with\n`lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: UpdatePublicIp",
|
|
"api_call": "PUT /publicIps/{publicIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Updates the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). Use this operation if you want to:\n\n* Assign a reserved public IP in your pool to a private IP.\n* Move a reserved public IP to a different private IP.\n* Unassign a reserved public IP from a private IP (which returns it to your pool\nof reserved public IPs).\n* Change the display name or tags for a public IP.\n\nAssigning, moving, and unassigning a reserved public IP are asynchronous\noperations. Poll the public IP's `lifecycleState` to determine if the operation\nsucceeded.\n\n**Note:** When moving a reserved public IP, the target private IP\nmust not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it\ndoes, an error is returned. Also, the initial unassignment from the original\nprivate IP always succeeds, but the assignment to the target private IP is asynchronous and\ncould fail silently (for example, if the target private IP is deleted or has a different public IP\nassigned to it in the interim). If that occurs, the public IP remains unassigned and its\n`lifecycleState` switches to AVAILABLE (it is not reassigned to its original private IP).\nYou must poll the public IP's `lifecycleState` to determine if the move succeeded.\n\nRegarding ephemeral public IPs:\n\n* If you want to assign an ephemeral public IP to a primary private IP, use\n[CreatePublicIp](#/en/iaas/latest/PublicIp/CreatePublicIp).\n* You can't move an ephemeral public IP to a different private IP.\n* If you want to unassign an ephemeral public IP from its private IP, use\n[DeletePublicIp](#/en/iaas/latest/PublicIp/DeletePublicIp), which\nunassigns and deletes the ephemeral public IP.\n\n**Note:** If a public IP is assigned to a secondary private\nIP (see [PrivateIp](#/en/iaas/latest/PrivateIp)), and you move that secondary\nprivate IP to another VNIC, the public IP moves with it.\n\n**Note:** There's a limit to the number of [public IPs](#/en/iaas/latest/PublicIp/)\na VNIC or instance can have. If you try to move a reserved public IP\nto a VNIC or instance that has already reached its public IP limit, an error is\nreturned. For information about the public IP limits, see\n[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: ChangePublicIpCompartment",
|
|
"api_call": "POST /publicIps/{publicIpId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Moves a public IP into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nThis operation applies only to reserved public IPs. Ephemeral public IPs always belong to the\nsame compartment as their VNIC and move accordingly.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips: ListPublicIps",
|
|
"api_call": "GET /publicIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"scope": "string: (Required) Whether the public IP is regional or specific to a particular availability domain.\n\n* `REGION`: The public IP exists within a region and is assigned to a regional entity\n(such as a [NatGateway](#/en/iaas/latest/NatGateway/)), or can be assigned to a private IP\nin any availability domain in the region. Reserved public IPs have `scope` = `REGION`, as do\nephemeral public IPs assigned to a regional entity.\n\n* `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity\nit's assigned to, which is specified by the `availabilityDomain` property of the public IP object.\nEphemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.\n",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"lifetime": "string: A filter to return only public IPs that match given lifetime.\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Lists the [PublicIp](#/en/iaas/latest/PublicIp/) objects\nin the specified compartment. You can filter the list by using query parameters.\n\nTo list your reserved public IPs:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `RESERVED`\n\nTo list the ephemeral public IPs assigned to a regional entity such as a NAT gateway:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `EPHEMERAL`\n\nTo list the ephemeral public IPs assigned to private IPs:\n * Set `scope` = `AVAILABILITY_DOMAIN` (required)\n * Set the `availabilityDomain` parameter to the desired availability domain (required)\n * Set `lifetime` = `EPHEMERAL`\n\n**Note:** An ephemeral public IP assigned to a private IP\nis always in the same availability domain and compartment as the private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips: CreatePublicIp",
|
|
"api_call": "POST /publicIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a public IP. Use the `lifetime` property to specify whether it's an ephemeral or\nreserved public IP. For information about limits on how many you can create, see\n[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n\n* **For an ephemeral public IP assigned to a private IP:** You must also specify a `privateIpId`\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary private IP you want to assign the public IP to. The public IP is\ncreated in the same availability domain as the private IP. An ephemeral public IP must always be\nassigned to a private IP, and only to the *primary* private IP on a VNIC, not a secondary\nprivate IP. Exception: If you create a [NatGateway](#/en/iaas/latest/NatGateway/), Oracle\nautomatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove.\n\n* **For a reserved public IP:** You may also optionally assign the public IP to a private\nIP by specifying `privateIpId`. Or you can later assign the public IP with\n[UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp).\n\n**Note:** When assigning a public IP to a private IP, the private IP must not already have\na public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned.\n\nAlso, for reserved public IPs, the optional assignment part of this operation is\nasynchronous. Poll the public IP's `lifecycleState` to determine if the assignment\nsucceeded.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id} > actions: ChangeRemotePeeringConnectionCompartment",
|
|
"api_call": "POST /remotePeeringConnections/{remotePeeringConnectionId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id} > actions: ConnectRemotePeeringConnections",
|
|
"api_call": "POST /remotePeeringConnections/{remotePeeringConnectionId}/actions/connect",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Connects this RPC to another one in a different region.\n\nThis operation must be called by the VCN administrator who is designated as\nthe *requestor* in the peering relationship. The *acceptor* must implement\nan Identity and Access Management (IAM) policy that gives the requestor permission\nto connect to RPCs in the acceptor's compartment. Without that permission, this\noperation will fail. For more information, see\n[VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id}: DeleteRemotePeeringConnection",
|
|
"api_call": "DELETE /remotePeeringConnections/{remotePeeringConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Deletes the remote peering connection (RPC).\n\nThis is an asynchronous operation; the RPC's `lifecycleState` changes to TERMINATING temporarily\nuntil the RPC is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id}: GetRemotePeeringConnection",
|
|
"api_call": "GET /remotePeeringConnections/{remotePeeringConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Get the specified remote peering connection's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id}: UpdateRemotePeeringConnection",
|
|
"api_call": "PUT /remotePeeringConnections/{remotePeeringConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Updates the specified remote peering connection (RPC).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections: ListRemotePeeringConnections",
|
|
"api_call": "GET /remotePeeringConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the remote peering connections (RPCs) for the specified DRG and compartment\n(the RPC's compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections: CreateRemotePeeringConnection",
|
|
"api_call": "POST /remotePeeringConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new remote peering connection (RPC) for the specified DRG.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: DeleteRouteTable",
|
|
"api_call": "DELETE /routeTables/{rtId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a\nVCN's default route table.\n\nThis is an asynchronous operation. The route table's `lifecycleState` will change to TERMINATING temporarily\nuntil the route table is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: GetRouteTable",
|
|
"api_call": "GET /routeTables/{rtId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Gets the specified route table's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: UpdateRouteTable",
|
|
"api_call": "PUT /routeTables/{rtId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Updates the specified route table's display name or route rules.\nAvoid entering confidential information.\n\nNote that the `routeRules` object you provide replaces the entire existing set of rules.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: ChangeRouteTableCompartment",
|
|
"api_call": "POST /routeTables/{rtId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Moves a route table into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables: ListRouteTables",
|
|
"api_call": "GET /routeTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the route tables in the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment.\nThe response includes the default route table that automatically comes with\neach VCN in the specified compartment, plus any route tables you've created.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables: CreateRouteTable",
|
|
"api_call": "POST /routeTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new route table for the specified VCN. In the request you must also include at least one route\nrule for the new route table. For information on the number of rules you can have in a route table, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For general information about route\ntables in your VCN and the types of targets you can use in route rules,\nsee [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the route\ntable to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets,\nor other Networking Service components. If you're not sure which compartment to use, put the route\ntable in the same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the route table, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: DeleteSecurityList",
|
|
"api_call": "DELETE /securityLists/{securityListId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Deletes the specified security list, but only if it's not associated with a subnet. You can't delete\na VCN's default security list.\n\nThis is an asynchronous operation. The security list's `lifecycleState` will change to TERMINATING temporarily\nuntil the security list is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: GetSecurityList",
|
|
"api_call": "GET /securityLists/{securityListId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Gets the specified security list's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: UpdateSecurityList",
|
|
"api_call": "PUT /securityLists/{securityListId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Updates the specified security list's display name or rules.\nAvoid entering confidential information.\n\nNote that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire\nexisting objects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: ChangeSecurityListCompartment",
|
|
"api_call": "POST /securityLists/{securityListId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Moves a security list into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists: ListSecurityLists",
|
|
"api_call": "GET /securityLists",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the security lists in the specified VCN and compartment.\nIf the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists: CreateSecurityList",
|
|
"api_call": "POST /securityLists",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new security list for the specified VCN. For more information\nabout security lists, see [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm).\nFor information on the number of rules you can have in a security list, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the security\nlist to reside. Notice that the security list doesn't have to be in the same compartment as the VCN, subnets,\nor other Networking Service components. If you're not sure which compartment to use, put the security\nlist in the same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the security list, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id} > actions: AttachService",
|
|
"api_call": "POST /serviceGateways/{serviceGatewayId}/actions/attachService",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Adds the specified [Service](#/en/iaas/latest/Service/) to the list of enabled\n`Service` objects for the specified gateway. You must also set up a route rule with the\n`cidrBlock` of the `Service` as the rule's destination and the service gateway as the rule's\ntarget. See [Route Table](#/en/iaas/latest/RouteTable/).\n\n**Note:** The `AttachServiceId` operation is an easy way to add an individual `Service` to\nthe service gateway. Compare it with\n[UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces\nthe entire existing list of enabled `Service` objects with the list that you provide in the\n`Update` call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id} > actions: ChangeServiceGatewayCompartment",
|
|
"api_call": "POST /serviceGateways/{serviceGatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Moves a service gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id} > actions: DetachService",
|
|
"api_call": "POST /serviceGateways/{serviceGatewayId}/actions/detachService",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Removes the specified [Service](#/en/iaas/latest/Service/) from the list of enabled\n`Service` objects for the specified gateway. You do not need to remove any route\nrules that specify this `Service` object's `cidrBlock` as the destination CIDR. However, consider\nremoving the rules if your intent is to permanently disable use of the `Service` through this\nservice gateway.\n\n**Note:** The `DetachServiceId` operation is an easy way to remove an individual `Service` from\nthe service gateway. Compare it with\n[UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces\nthe entire existing list of enabled `Service` objects with the list that you provide in the\n`Update` call. `UpdateServiceGateway` also lets you block all traffic through the service\ngateway without having to remove each of the individual `Service` objects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id}: DeleteServiceGateway",
|
|
"api_call": "DELETE /serviceGateways/{serviceGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Deletes the specified service gateway. There must not be a route table that lists the service\ngateway as a target.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id}: GetServiceGateway",
|
|
"api_call": "GET /serviceGateways/{serviceGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Gets the specified service gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id}: UpdateServiceGateway",
|
|
"api_call": "PUT /serviceGateways/{serviceGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Updates the specified service gateway. The information you provide overwrites the existing\nattributes of the gateway.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways: ListServiceGateways",
|
|
"api_call": "GET /serviceGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID\nto filter the results by VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways: CreateServiceGateway",
|
|
"api_call": "POST /serviceGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new service gateway in the specified compartment.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe service gateway to reside. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the service gateway, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - services: ListServices",
|
|
"api_call": "GET /services",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the available [Service](#/en/iaas/latest/Service/) objects that you can enable for a\nservice gateway in this region.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - services: GetService",
|
|
"api_call": "GET /services/{serviceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"serviceId": "[REQUIRED] string: (Required) The service's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Gets the specified [Service](#/en/iaas/latest/Service/) object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: DeleteSubnet",
|
|
"api_call": "DELETE /subnets/{subnetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous\noperation. The subnet's `lifecycleState` will change to TERMINATING temporarily. If there are any\ninstances in the subnet, the state will instead change back to AVAILABLE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: GetSubnet",
|
|
"api_call": "GET /subnets/{subnetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Gets the specified subnet's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: UpdateSubnet",
|
|
"api_call": "PUT /subnets/{subnetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Updates the specified subnet.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: ChangeSubnetCompartment",
|
|
"api_call": "POST /subnets/{subnetId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Moves a subnet into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets: ListSubnets",
|
|
"api_call": "GET /subnets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the subnets in the specified VCN and the specified compartment.\nIf the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets: CreateSubnet",
|
|
"api_call": "POST /subnets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation,\nso it's important to think about the size of subnets you need before creating them.\nFor more information, see [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm).\nFor information on the number of subnets you can have in a VCN, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the subnet\nto reside. Notice that the subnet doesn't have to be in the same compartment as the VCN, route tables, or\nother Networking Service components. If you're not sure which compartment to use, put the subnet in\nthe same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs,\nsee [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally associate a route table with the subnet. If you don't, the subnet will use the\nVCN's default route table. For more information about route tables, see\n[Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n\nYou may optionally associate a security list with the subnet. If you don't, the subnet will use the\nVCN's default security list. For more information about security lists, see\n[Security Lists](/iaas/Content/Network/Concepts/securitylists.htm).\n\nYou may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the\nVCN's default set. For more information about DHCP options, see\n[DHCP Options](/iaas/Content/Network/Tasks/managingDHCP.htm).\n\nYou may optionally specify a *display name* for the subnet, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nYou can also add a DNS label for the subnet, which is required if you want the Internet and\nVCN Resolver to resolve hostnames for instances in the subnet. For more information, see\n[DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: AddVcnCidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/addCidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Adds a CIDR block to a VCN. The CIDR block you add:\n\n- Must be valid.\n- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.\n- Must not exceed the limit of CIDR blocks allowed per VCN.\n\n**Note:** Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: AddVcnIpv6Cidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/addIpv6Cidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Add an IPv6 CIDR to a VCN. The VCN size is always /56.\nAddVcnIpv6CidrDetails provides flexibility to have different private and public IPv6 address space.\nOnce added the IPv6 CIDR block cannot be removed or modified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: ChangeVcnCompartment",
|
|
"api_call": "POST /vcns/{vcnId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Moves a VCN into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: ModifyVcnCidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/modifyCidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria:\n\n- Must be valid.\n- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.\n- Must not exceed the limit of CIDR blocks allowed per VCN.\n- Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules.\n- No IP address in an existing subnet should be outside of the new CIDR block range.\n\n**Note:** Modifying a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can vary depending on the size of your network. Updating a small network could take about a minute, and updating a large network could take up to an hour. You can use the `GetWorkRequest` operation to check the status of the update.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: RemoveVcnCidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/removeCidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Removes a specified CIDR block from a VCN.\n\n**Notes:**\n- You cannot remove a CIDR block if an IP address in its range is in use.\n- Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id}: DeleteVcn",
|
|
"api_call": "DELETE /vcns/{vcnId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Deletes the specified VCN. The VCN must be empty and have no attached gateways. This is an asynchronous\noperation. The VCN's `lifecycleState` will change to TERMINATING temporarily until the VCN is completely\nremoved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id}: GetVcn",
|
|
"api_call": "GET /vcns/{vcnId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Gets the specified VCN's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id}: UpdateVcn",
|
|
"api_call": "PUT /vcns/{vcnId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Updates the specified VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns: ListVcns",
|
|
"api_call": "GET /vcns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the virtual cloud networks (VCNs) in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns: CreateVcn",
|
|
"api_call": "POST /vcns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new virtual cloud network (VCN). For more information, see\n[VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm).\n\nFor the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria:\n\n- The CIDR blocks must be valid.\n- They must not overlap with each other or with the on-premises network CIDR block. \n- The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN.\n\nFor a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in [RFC 1918](https://tools.ietf.org/html/rfc1918) (10.0.0.0/8, 172.16/12, and 192.168/16). Example:\n172.16.0.0/16. The CIDR blocks can range from /16 to /30.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the VCN to\nreside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which\ncompartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other\nNetworking Service components. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the VCN, otherwise a default is provided. It does not have to\nbe unique, and you can change it. Avoid entering confidential information.\n\nYou can also add a DNS label for the VCN, which is required if you want the instances to use the\nInterent and VCN Resolver option for DNS in the VCN. For more information, see\n[DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm).\n\nThe VCN automatically comes with a default route table, default security list, and default set of DHCP options.\nThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) for each is returned in the response. You can't delete these default objects, but you can change their\ncontents (that is, change the route rules, security list rules, and so on).\n\nThe VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN\nor FastConnect. For more information, see\n[Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id} > actions: BulkAddVirtualCircuitPublicPrefixes",
|
|
"api_call": "POST /virtualCircuits/{virtualCircuitId}/actions/bulkAddPublicPrefixes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Adds one or more customer public IP prefixes to the specified public virtual circuit.\nUse this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit))\nto add prefixes to the virtual circuit. Oracle must verify the customer's ownership\nof each prefix before traffic for that prefix will flow across the virtual circuit.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id} > actions: BulkDeleteVirtualCircuitPublicPrefixes",
|
|
"api_call": "POST /virtualCircuits/{virtualCircuitId}/actions/bulkDeletePublicPrefixes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Removes one or more customer public IP prefixes from the specified public virtual circuit.\nUse this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit))\nto remove prefixes from the virtual circuit. When the virtual circuit's state switches\nback to PROVISIONED, Oracle stops advertising the specified prefixes across the connection.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id} > actions: ChangeVirtualCircuitCompartment",
|
|
"api_call": "POST /virtualCircuits/{virtualCircuitId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Moves a virtual circuit into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: DeleteVirtualCircuit",
|
|
"api_call": "DELETE /virtualCircuits/{virtualCircuitId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Deletes the specified virtual circuit.\n\n**Important:** If you're using FastConnect via a provider,\nmake sure to also terminate the connection with\nthe provider, or else the provider may continue to bill you.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: GetVirtualCircuit",
|
|
"api_call": "GET /virtualCircuits/{virtualCircuitId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Gets the specified virtual circuit's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: UpdateVirtualCircuit",
|
|
"api_call": "PUT /virtualCircuits/{virtualCircuitId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Updates the specified virtual circuit. This can be called by\neither the customer who owns the virtual circuit, or the\nprovider (when provisioning or de-provisioning the virtual\ncircuit from their end). The documentation for\n[UpdateVirtualCircuitDetails](#/en/iaas/latest/requests/UpdateVirtualCircuitDetails)\nindicates who can update each property of the virtual circuit.\n\n**Important:** If the virtual circuit is working and in the\nPROVISIONED state, updating any of the network-related properties\n(such as the DRG being used, the BGP ASN, and so on) will cause the virtual\ncircuit's state to switch to PROVISIONING and the related BGP\nsession to go down. After Oracle re-provisions the virtual circuit,\nits state will return to PROVISIONED. Make sure you confirm that\nthe associated BGP session is back up. For more information\nabout the various states and how to test connectivity, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nTo change the list of public IP prefixes for a public virtual circuit,\nuse [BulkAddVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkAddVirtualCircuitPublicPrefixes)\nand\n[BulkDeleteVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkDeleteVirtualCircuitPublicPrefixes).\nUpdating the list of prefixes does NOT cause the BGP session to go down. However,\nOracle must verify the customer's ownership of each added prefix before\ntraffic for that prefix will flow across the virtual circuit.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: ListVirtualCircuitPublicPrefixes",
|
|
"api_call": "GET /virtualCircuits/{virtualCircuitId}/publicPrefixes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"verificationState": "string: A filter to only return resources that match the given verification\nstate.\n\nThe state value is case-insensitive.\n",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Lists the public IP prefixes and their details for the specified\npublic virtual circuit.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits: ListVirtualCircuits",
|
|
"api_call": "GET /virtualCircuits",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the virtual circuits in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits: CreateVirtualCircuit",
|
|
"api_call": "POST /virtualCircuits",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new virtual circuit to use with Oracle Cloud\nInfrastructure FastConnect. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the virtual circuit to reside. If you're\nnot sure which compartment to use, put the virtual circuit in the\nsame compartment with the DRG it's using. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the virtual circuit.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\n**Important:** When creating a virtual circuit, you specify a DRG for\nthe traffic to flow through. Make sure you attach the DRG to your\nVCN and confirm the VCN's routing sends traffic to the DRG. Otherwise\ntraffic will not flow. For more information, see\n[Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: DeleteVlan",
|
|
"api_call": "DELETE /vlans/{vlanId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Deletes the specified VLAN, but only if there are no VNICs in the VLAN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: GetVlan",
|
|
"api_call": "GET /vlans/{vlanId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Gets the specified VLAN's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: UpdateVlan",
|
|
"api_call": "PUT /vlans/{vlanId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Updates the specified VLAN. Note that this operation might require changes to all\nthe VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: ChangeVlanCompartment",
|
|
"api_call": "POST /vlans/{vlanId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Moves a VLAN into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans: ListVlans",
|
|
"api_call": "GET /vlans",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the VLANs in the specified VCN and the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans: CreateVlan",
|
|
"api_call": "POST /vlans",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a VLAN in the specified VCN and the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments > {vnic Attachment Id}: DetachVnic",
|
|
"api_call": "DELETE /vnicAttachments/{vnicAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vnicAttachmentId": "[REQUIRED] string: (Required) The OCID of the VNIC attachment."
|
|
},
|
|
"functionality": "Detaches and deletes the specified secondary VNIC.\nThis operation cannot be used on the instance's primary VNIC.\nWhen you terminate an instance, all attached VNICs (primary\nand secondary) are automatically detached and deleted.\n\n**Important:** If the VNIC has a\n[private IP](#/en/iaas/latest/PrivateIp/) that is the\n[target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),\ndeleting the VNIC causes that route rule to blackhole and the traffic\nwill be dropped.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments > {vnic Attachment Id}: GetVnicAttachment",
|
|
"api_call": "GET /vnicAttachments/{vnicAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vnicAttachmentId": "[REQUIRED] string: (Required) The OCID of the VNIC attachment."
|
|
},
|
|
"functionality": "Gets the information for the specified VNIC attachment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments: ListVnicAttachments",
|
|
"api_call": "GET /vnicAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"vnicId": "string: The OCID of the VNIC."
|
|
},
|
|
"functionality": "Lists the VNIC attachments in the specified compartment. A VNIC attachment\nresides in the same compartment as the attached instance. The list can be\nfiltered by instance, VNIC, or availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments: AttachVnic",
|
|
"api_call": "POST /vnicAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a secondary VNIC and attaches it to the specified instance.\nFor more information about secondary VNICs, see\n[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnics/{vnic Id}: GetVnic",
|
|
"api_call": "GET /vnics/{vnicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vnicId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC."
|
|
},
|
|
"functionality": "Gets the information for the specified virtual network interface card (VNIC).\nYou can get the VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm) from the\n[ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnics/{vnic Id}: UpdateVnic",
|
|
"api_call": "PUT /vnics/{vnicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vnicId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC."
|
|
},
|
|
"functionality": "Updates the specified VNIC.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments > {volume Attachment Id}: DetachVolume",
|
|
"api_call": "DELETE /volumeAttachments/{volumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the volume attachment."
|
|
},
|
|
"functionality": "Detaches a storage volume from an instance. You must specify the OCID of the volume attachment.\n\nThis is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily\nuntil the attachment is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments > {volume Attachment Id}: GetVolumeAttachment",
|
|
"api_call": "GET /volumeAttachments/{volumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the volume attachment."
|
|
},
|
|
"functionality": "Gets information about the specified volume attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments > {volume Attachment Id}: UpdateVolumeAttachment",
|
|
"api_call": "PUT /volumeAttachments/{volumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the volume attachment."
|
|
},
|
|
"functionality": "Updates information about the specified volume attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments: ListVolumeAttachments",
|
|
"api_call": "GET /volumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"volumeId": "string: The OCID of the volume."
|
|
},
|
|
"functionality": "Lists the volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, volume OCID, or both.\n\nCurrently, the only supported volume attachment type are [IScsiVolumeAttachment](#/en/iaas/latest/IScsiVolumeAttachment/) and\n[ParavirtualizedVolumeAttachment](#/en/iaas/latest/ParavirtualizedVolumeAttachment/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments: AttachVolume",
|
|
"api_call": "POST /volumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Attaches the specified storage volume to the specified instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies > {policy Id}: DeleteVolumeBackupPolicy",
|
|
"api_call": "DELETE /volumeBackupPolicies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the volume backup policy."
|
|
},
|
|
"functionality": "Deletes a user defined backup policy.\n For more information about user defined backup policies,\n see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies).\n\n Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies > {policy Id}: GetVolumeBackupPolicy",
|
|
"api_call": "GET /volumeBackupPolicies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the volume backup policy."
|
|
},
|
|
"functionality": "Gets information for the specified volume backup policy.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies > {policy Id}: UpdateVolumeBackupPolicy",
|
|
"api_call": "PUT /volumeBackupPolicies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the volume backup policy."
|
|
},
|
|
"functionality": "Updates a user defined backup policy.\n For more information about user defined backup policies,\n see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies).\n\n Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies: ListVolumeBackupPolicies",
|
|
"api_call": "GET /volumeBackupPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"compartmentId": "string: The OCID of the compartment.\nIf no compartment is specified, the Oracle defined backup policies are listed.\n"
|
|
},
|
|
"functionality": "Lists all the volume backup policies available in the specified compartment.\n\nFor more information about Oracle defined backup policies and user defined backup policies,\nsee [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies: CreateVolumeBackupPolicy",
|
|
"api_call": "POST /volumeBackupPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new user defined backup policy.\n\nFor more information about Oracle defined backup policies and user defined backup policies,\nsee [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments > {policy Assignment Id}: DeleteVolumeBackupPolicyAssignment",
|
|
"api_call": "DELETE /volumeBackupPolicyAssignments/{policyAssignmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyAssignmentId": "[REQUIRED] string: (Required) The OCID of the volume backup policy assignment."
|
|
},
|
|
"functionality": "Deletes a volume backup policy assignment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments > {policy Assignment Id}: GetVolumeBackupPolicyAssignment",
|
|
"api_call": "GET /volumeBackupPolicyAssignments/{policyAssignmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyAssignmentId": "[REQUIRED] string: (Required) The OCID of the volume backup policy assignment."
|
|
},
|
|
"functionality": "Gets information for the specified volume backup policy assignment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments: GetVolumeBackupPolicyAssetAssignment",
|
|
"api_call": "GET /volumeBackupPolicyAssignments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"assetId": "string: (Required) The OCID of an asset (e.g. a volume).",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Gets the volume backup policy assignment for the specified volume. The\n`assetId` query parameter is required, and the returned list will contain at most\none item, since volume can only have one volume backup policy assigned at a time.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments: CreateVolumeBackupPolicyAssignment",
|
|
"api_call": "POST /volumeBackupPolicyAssignments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Assigns a volume backup policy to the specified volume. Note that a given volume can\nonly have one backup policy assigned to it. If this operation is used for a volume that already\nhas a different backup policy assigned, the prior backup policy will be silently unassigned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id} > actions: ChangeVolumeBackupCompartment",
|
|
"api_call": "POST /volumeBackups/{volumeBackupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Moves a volume backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id} > actions: CreateVolumeBackupCopy",
|
|
"api_call": "POST /volumeBackups/{volumeBackupId}/actions/copy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Creates a volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id}: DeleteVolumeBackup",
|
|
"api_call": "DELETE /volumeBackups/{volumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Deletes a volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id}: GetVolumeBackup",
|
|
"api_call": "GET /volumeBackups/{volumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Gets information for the specified volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id}: UpdateVolumeBackup",
|
|
"api_call": "PUT /volumeBackups/{volumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Updates the display name for the specified volume backup.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups: ListVolumeBackups",
|
|
"api_call": "GET /volumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the volume backups in the specified compartment. You can filter the results by volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups: CreateVolumeBackup",
|
|
"api_call": "POST /volumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new backup of the specified volume. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id} > actions: ChangeVolumeGroupBackupCompartment",
|
|
"api_call": "POST /volumeGroupBackups/{volumeGroupBackupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Moves a volume group backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id} > actions: CreateVolumeGroupBackupCopy",
|
|
"api_call": "POST /volumeGroupBackups/{volumeGroupBackupId}/actions/copy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Creates a volume group backup copy in specified region. For general information about volume group backups,\nsee [Overview of Block Volume Service Backups](/Content/Block/Concepts/blockvolumebackups.htm)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id}: DeleteVolumeGroupBackup",
|
|
"api_call": "DELETE /volumeGroupBackups/{volumeGroupBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Deletes a volume group backup. This operation deletes all the backups in\nthe volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id}: GetVolumeGroupBackup",
|
|
"api_call": "GET /volumeGroupBackups/{volumeGroupBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id}: UpdateVolumeGroupBackup",
|
|
"api_call": "PUT /volumeGroupBackups/{volumeGroupBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Updates the display name for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups: ListVolumeGroupBackups",
|
|
"api_call": "GET /volumeGroupBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"volumeGroupId": "string: The OCID of the volume group.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the volume group backups in the specified compartment. You can filter the results by volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups: CreateVolumeGroupBackup",
|
|
"api_call": "POST /volumeGroupBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new backup volume group of the specified volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: DeleteVolumeGroup",
|
|
"api_call": "DELETE /volumeGroups/{volumeGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: GetVolumeGroup",
|
|
"api_call": "GET /volumeGroups/{volumeGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Gets information for the specified volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: UpdateVolumeGroup",
|
|
"api_call": "PUT /volumeGroups/{volumeGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Updates the set of volumes in a volume group along with the display name. Use this operation\nto add or remove volumes in a volume group. Specify the full list of volume IDs to include in the\nvolume group. If the volume ID is not specified in the call, it will be removed from the volume group.\nAvoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: ChangeVolumeGroupCompartment",
|
|
"api_call": "POST /volumeGroups/{volumeGroupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Moves a volume group into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups: ListVolumeGroups",
|
|
"api_call": "GET /volumeGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the volume groups in the specified compartment and availability domain.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups: CreateVolumeGroup",
|
|
"api_call": "POST /volumeGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new volume group in the specified compartment.\nA volume group is a collection of volumes and may be created from a list of volumes, cloning an existing\nvolume group, or by restoring a volume group backup.\nYou may optionally specify a *display name* for the volume group, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id} > kms Key: DeleteVolumeKmsKey",
|
|
"api_call": "DELETE /volumes/{volumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Removes the specified volume's assigned Key Management encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id} > kms Key: GetVolumeKmsKey",
|
|
"api_call": "GET /volumes/{volumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Gets the Key Management encryption key assigned to the specified volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id} > kms Key: UpdateVolumeKmsKey",
|
|
"api_call": "PUT /volumes/{volumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Updates the specified volume with a new Key Management master encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: DeleteVolume",
|
|
"api_call": "DELETE /volumes/{volumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Deletes the specified volume. The volume cannot have an active connection to an instance.\nTo disconnect the volume from a connected instance, see\n[Disconnecting From a Volume](/iaas/Content/Block/Tasks/disconnectingfromavolume.htm).\n**Warning:** All data on the volume will be permanently lost when the volume is deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: GetVolume",
|
|
"api_call": "GET /volumes/{volumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Gets information for the specified volume.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: UpdateVolume",
|
|
"api_call": "PUT /volumes/{volumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Updates the specified volume's display name.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: ChangeVolumeCompartment",
|
|
"api_call": "POST /volumes/{volumeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Moves a volume into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes: ListVolumes",
|
|
"api_call": "GET /volumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the volumes in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes: CreateVolume",
|
|
"api_call": "POST /volumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from\n50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB).\nFor general information about block volumes, see\n[Overview of Block Volume Service](/iaas/Content/Block/Concepts/overview.htm).\n\nA volume and instance can be in separate compartments but must be in the same availability domain.\nFor information about access control and compartments, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about\navailability domains, see [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).\nTo get a list of availability domains, use the `ListAvailabilityDomains` operation\nin the Identity and Access Management Service API.\n\nYou may optionally specify a *display name* for the volume, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListAllowedPeerRegionsForRemotePeering",
|
|
"api_call": "GET /allowedPeerRegionsForRemotePeering",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header"
|
|
},
|
|
"functionality": "Lists the regions that support remote VCN peering (which is peering across regions).\nFor more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListComputeCapacityReservationInstanceShapes",
|
|
"api_call": "GET /computeCapacityReservationInstanceShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be reserved within the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListCrossConnectLocations",
|
|
"api_call": "GET /crossConnectLocations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the available FastConnect locations for cross-connect installation. You need\nthis information so you can specify your desired location when you create a cross-connect.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListCrossConnectPortSpeedShapes",
|
|
"api_call": "GET /crossConnectPortSpeedShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the available port speeds for cross-connects. You need this information\nso you can specify your desired port speed (that is, shape) when you create a\ncross-connect.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListDedicatedVmHostInstanceShapes",
|
|
"api_call": "GET /dedicatedVmHostInstanceShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"dedicatedVmHostShape": "string: Dedicated VM host shape name\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.\nYou can filter the list by compatibility with a specific dedicated virtual machine host shape.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListDedicatedVmHostShapes",
|
|
"api_call": "GET /dedicatedVmHostShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"instanceShapeName": "string: The name for the instance's shape.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: Get a Virtual Networking topology for the current region",
|
|
"api_call": "GET /networkingTopology",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-none-match": "string: For querying if there is a cached value on the server. The If-None-Match HTTP request header \nmakes the request conditional. For GET and HEAD methods, the server will send back the requested \nresource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nFor other methods, the request will be processed only if the eventually existing resource's \nETag doesn't match any of the values listed.\n",
|
|
"cache-control": "string: The Cache-Control HTTP header holds directives (instructions)\nfor caching in both requests and responses.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"accessLevel": "string: Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`.\nSetting this to `ACCESSIBLE` returns only compartments for which a\nuser has INSPECT permissions, either directly or indirectly (permissions can be on a\nresource in a subcompartment). A restricted set of fields is returned for compartments in which a user has\nindirect INSPECT permissions.\n\nWhen set to `ANY` permissions are not checked.\n",
|
|
"queryCompartmentSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand the specified compartment and its subcompartments are\ninspected depending on the the setting of `accessLevel`.\nDefault is false.\n"
|
|
},
|
|
"functionality": "Gets a virtual networking topology for the current region.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListShapes",
|
|
"api_call": "GET /shapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be used to launch an instance within the specified compartment. You can\nfilter the list by compatibility with a specific image.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: Get Virtual Network VCN topology",
|
|
"api_call": "GET /vcnTopology",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-none-match": "string: For querying if there is a cached value on the server. The If-None-Match HTTP request header \nmakes the request conditional. For GET and HEAD methods, the server will send back the requested \nresource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nFor other methods, the request will be processed only if the eventually existing resource's \nETag doesn't match any of the values listed.\n",
|
|
"cache-control": "string: The Cache-Control HTTP header holds directives (instructions)\nfor caching in both requests and responses.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"accessLevel": "string: Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`.\nSetting this to `ACCESSIBLE` returns only compartments for which a\nuser has INSPECT permissions, either directly or indirectly (permissions can be on a\nresource in a subcompartment). A restricted set of fields is returned for compartments in which a user has\nindirect INSPECT permissions.\n\nWhen set to `ANY` permissions are not checked.\n",
|
|
"queryCompartmentSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand the specified compartment and its subcompartments are\ninspected depending on the the setting of `accessLevel`.\nDefault is false.\n",
|
|
"vcnId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Gets a virtual network topology for a given VCN.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListVirtualCircuitBandwidthShapes",
|
|
"api_call": "GET /virtualCircuitBandwidthShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "The deprecated operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - Model - Instance: Gets information about the specified instance",
|
|
"api_call": "GET /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string",
|
|
"compartmentId": "string: (Required) The OCID of the Compartment",
|
|
"instanceId": "[REQUIRED] string: (Required) The OCID of the instance"
|
|
},
|
|
"functionality": "Gets information about the specified instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - Model - Instance: Lists the instances",
|
|
"api_call": "GET /instances/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string",
|
|
"compartmentId": "string: (Required) The OCID of the Compartment"
|
|
},
|
|
"functionality": "Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id} > actions: CancelJobRun",
|
|
"api_call": "POST /jobRuns/{jobRunId}/actions/cancelJobRun",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Cancels an IN_PROGRESS job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id} > actions: ChangeJobRunCompartment",
|
|
"api_call": "POST /jobRuns/{jobRunId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Changes a job run's compartment",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id}: DeleteJobRun",
|
|
"api_call": "DELETE /jobRuns/{jobRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Deletes a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id}: GetJobRun",
|
|
"api_call": "GET /jobRuns/{jobRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Gets a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id}: UpdateJobRun",
|
|
"api_call": "PUT /jobRuns/{jobRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Updates a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs: ListJobRuns",
|
|
"api_call": "GET /jobRuns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"jobId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
|
|
},
|
|
"functionality": "List out job runs.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs: CreateJobRun",
|
|
"api_call": "POST /jobRuns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id} > artifact > content: GetJobArtifactContent",
|
|
"api_call": "GET /jobs/{jobId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"range": "string: Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7232#section-2.1), section 2.1.\nNote that only a single range of bytes is supported.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Downloads job artifact content for specified job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id} > artifact > content: HeadJobArtifact",
|
|
"api_call": "HEAD /jobs/{jobId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Gets job artifact metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id} > artifact: CreateJobArtifact",
|
|
"api_call": "POST /jobs/{jobId}/artifact",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"content-disposition": "string: This header allows you to specify a filename during upload. This file name is used to dispose of the file contents\nwhile downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file\nname when downloading.\nExample: `{\"Content-Disposition\": \"attachment\"\n \"filename\"=\"model.tar.gz\"\n \"Content-Length\": \"2347\"\n \"Content-Type\": \"application/gzip\"}`\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Uploads a job artifact.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: DeleteJob",
|
|
"api_call": "DELETE /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"deleteRelatedJobRuns": "boolean: Delete all JobRuns associated with this job.",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Deletes a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: GetJob",
|
|
"api_call": "GET /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Gets a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: UpdateJob",
|
|
"api_call": "PUT /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Updates a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: ChangeJobCompartment",
|
|
"api_call": "POST /jobs/{jobId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Changes a job's compartment",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs: ListJobs",
|
|
"api_call": "GET /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\n state for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "List jobs in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs: CreateJob",
|
|
"api_call": "POST /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id} > actions: Activates the model deployment.",
|
|
"api_call": "POST /modelDeployments/{modelDeploymentId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Activates the model deployment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id} > actions: Moves a model deployment into a different compartment.",
|
|
"api_call": "POST /modelDeployments/{modelDeploymentId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Moves a model deployment into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id} > actions: Deactivates the model deployment.",
|
|
"api_call": "POST /modelDeployments/{modelDeploymentId}/actions/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Deactivates the model deployment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id}: Deletes the model deployment.",
|
|
"api_call": "DELETE /modelDeployments/{modelDeploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Deletes the specified model deployment. Any unsaved work in this model deployment is lost.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id}: Gets the model deployment.",
|
|
"api_call": "GET /modelDeployments/{modelDeploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Retrieves the model deployment for the specified `modelDeploymentId`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id}: Updates the model deployment.",
|
|
"api_call": "PUT /modelDeployments/{modelDeploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Updates the properties of a model deployment. Some of the properties of `modelDeploymentConfigurationDetails` or `CategoryLogDetails` can also be updated with zero down time\nwhen the model deployment\u2019s lifecycle state is ACTIVE or NEEDS_ATTENTION i.e `instanceShapeName`, `instanceCount` and `modelId`, separately `loadBalancerShape` or `CategoryLogDetails`\ncan also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model\ndeployment is activated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments: Lists the model deployments.",
|
|
"api_call": "GET /modelDeployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists all model deployments in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments: Creates a new model deployment.",
|
|
"api_call": "POST /modelDeployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new model deployment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > actions: ActivateModel",
|
|
"api_call": "POST /models/{modelId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Activates the model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > actions: ChangeModelCompartment",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Moves a model resource into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > actions: DeactivateModel",
|
|
"api_call": "POST /models/{modelId}/actions/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Deactivates the model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > artifact > content: GetModelArtifactContent",
|
|
"api_call": "GET /models/{modelId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"range": "string: Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7232#section-2.1), section 2.1.\nNote that only a single range of bytes is supported.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Downloads model artifact content for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > artifact > content: HeadModelArtifact",
|
|
"api_call": "HEAD /models/{modelId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Gets model artifact metadata for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > artifact: CreateModelArtifact",
|
|
"api_call": "POST /models/{modelId}/artifact",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"content-disposition": "string: This header allows you to specify a filename during upload. This file name is used to dispose of the file contents\nwhile downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file\nname when downloading.\nExample: `{\"Content-Disposition\": \"attachment\"\n \"filename\"=\"model.tar.gz\"\n \"Content-Length\": \"2347\"\n \"Content-Type\": \"application/gzip\"}`\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Creates model artifact for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > provenance: GetModelProvenance",
|
|
"api_call": "GET /models/{modelId}/provenance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Gets provenance information for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > provenance: CreateModelProvenance",
|
|
"api_call": "POST /models/{modelId}/provenance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Creates provenance information for the specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > provenance: UpdateModelProvenance",
|
|
"api_call": "PUT /models/{modelId}/provenance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Updates the provenance information for the specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id}: DeleteModel",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Deletes the specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id}: GetModel",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Gets the specified model's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id}: UpdateModel",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Updates the properties of a model. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models: ListModels",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists models in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models: CreateModel",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id} > actions: ActivateNotebookSession",
|
|
"api_call": "POST /notebookSessions/{notebookSessionId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Activates the notebook session.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id} > actions: ChangeNotebookSessionCompartment",
|
|
"api_call": "POST /notebookSessions/{notebookSessionId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Moves a notebook session resource into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id} > actions: DeactivateNotebookSession",
|
|
"api_call": "POST /notebookSessions/{notebookSessionId}/actions/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Deactivates the notebook session.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id}: DeleteNotebookSession",
|
|
"api_call": "DELETE /notebookSessions/{notebookSessionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Deletes the specified notebook session. Any unsaved work in this notebook session are lost.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id}: GetNotebookSession",
|
|
"api_call": "GET /notebookSessions/{notebookSessionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Gets the specified notebook session's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id}: UpdateNotebookSession",
|
|
"api_call": "PUT /notebookSessions/{notebookSessionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Updates the properties of a notebook session. You can update the `displayName`, `freeformTags`, and `definedTags` properties.\nWhen the notebook session is in the INACTIVE lifecycle state, you can update `notebookSessionConfigurationDetails` and change `shape`, `subnetId`, and `blockStorageSizeInGBs`.\nChanges to the `notebookSessionConfigurationDetails` take effect the next time the `ActivateNotebookSession` action is invoked on the notebook session resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions: ListNotebookSessions",
|
|
"api_call": "GET /notebookSessions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the notebook sessions in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions: CreateNotebookSession",
|
|
"api_call": "POST /notebookSessions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new notebook session.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: DeleteProject",
|
|
"api_call": "DELETE /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: GetProject",
|
|
"api_call": "GET /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Gets the specified project's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: UpdateProject",
|
|
"api_call": "PUT /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Updates the properties of a project. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: ChangeProjectCompartment",
|
|
"api_call": "POST /projects/{projectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Moves a project resource into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects: ListProjects",
|
|
"api_call": "GET /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists projects in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects: CreateProject",
|
|
"api_call": "POST /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: CancelWorkRequest",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Cancels a work request that has not started.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: GetWorkRequest",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Gets the specified work request's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: ListWorkRequestErrors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Lists work request errors for the specified work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: ListWorkRequestLogs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Lists work request logs for the specified work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests: ListWorkRequests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"operationType": "string: <b>Filter</b> results by the type of the operation associated with the work request.",
|
|
"status": "string: <b>Filter</b> results by work request status.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.\n"
|
|
},
|
|
"functionality": "Lists work requests in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: ListJobShapes",
|
|
"api_call": "GET /jobShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n"
|
|
},
|
|
"functionality": "List job shapes available in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: Lists the valid model deployment shapes.",
|
|
"api_call": "GET /modelDeploymentShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n"
|
|
},
|
|
"functionality": "Lists the valid model deployment shapes.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: ListNotebookSessionShapes",
|
|
"api_call": "GET /notebookSessionShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n"
|
|
},
|
|
"functionality": "Lists the valid notebook session shapes.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: EXAMPLE Model Invoke",
|
|
"api_call": "POST /{data_science_model_deployment_ocid}/predict",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"x-content-sha256": "string",
|
|
"Content-Type": "string",
|
|
"Authorization": "string",
|
|
"Date": "string",
|
|
"data_science_model_deployment_ocid": "[REQUIRED] string"
|
|
},
|
|
"functionality": "",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Moves an Digital Assistant instance into a different compartment.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against\nETag values of the resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Configure the Digital Assistant Parameters for the Digital Assistant instance",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/configureDigitalAssistantParameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Import Bot",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/importBot",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Import a Bot archive from Object Storage.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Starts an inactive Digital Assistant instance.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering\nof requests will be started again.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Stops an active Digital Assistant instance.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering\nof requests will be stopped until the instance is started again. Data associated with the instance\nis not affected.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments > {attachment Id}: Delete a Digital Assistant instance attachment",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/attachments/{attachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"attachmentId": "[REQUIRED] string: (Required) Unique Digital Assistant instance attachment identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to delete the specified Digital Assistant instance attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments > {attachment Id}: Get ODA instance attachment information",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/attachments/{attachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"includeOwnerMetadata": "boolean: Whether to send attachment owner info during get/list call.",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"attachmentId": "[REQUIRED] string: (Required) Unique Digital Assistant instance attachment identifier."
|
|
},
|
|
"functionality": "Gets an ODA instance attachment by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments > {attachment Id}: Update the ODA instance attachment identified by the ID",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/attachments/{attachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"attachmentId": "[REQUIRED] string: (Required) Unique Digital Assistant instance attachment identifier."
|
|
},
|
|
"functionality": "Updates the ODA instance attachment",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments: Gets a list of all attachments to an ODA instance",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/attachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a list of ODA instance attachments\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments: Create Digital Assistant Instance Attachment",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/attachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to create a Digital Assistant instance attachment.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers > {authentication Provider Id}: Delete Authentication Provider",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"authenticationProviderId": "[REQUIRED] string: (Required) Unique Authentication Provider identifier."
|
|
},
|
|
"functionality": "Delete the specified Authentication Provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers > {authentication Provider Id}: Get Authentication Provider",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"authenticationProviderId": "[REQUIRED] string: (Required) Unique Authentication Provider identifier."
|
|
},
|
|
"functionality": "Gets the specified Authentication Provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers > {authentication Provider Id}: Update Authentication Provider",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"authenticationProviderId": "[REQUIRED] string: (Required) Unique Authentication Provider identifier."
|
|
},
|
|
"functionality": "Updates the specified Authentication Provider with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers: List Authentication Providers",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/authenticationProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers: Create Authentication Provider",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/authenticationProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Authentication Provider\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id} > actions: Rotate generated keys for the Channel.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels/{channelId}/actions/rotateKeys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken).\nIf a Channel has no generated keys then no changes will be made.\nEnsure that you take note of the newly generated keys in the response as they will not be returned again.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id} > actions: Start a Channel.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels/{channelId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Starts a Channel so that it will begin accepting messages.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id} > actions: Stop a Channel.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels/{channelId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Stops a Channel so that it will no longer accept messages.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id}: Delete Channel",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/channels/{channelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Delete the specified Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id}: Get Channel",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/channels/{channelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Gets the specified Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id}: Update Channel",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/channels/{channelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Updates the specified Channel with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels: List Channels",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/channels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Channels that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels: Create Channel",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Channel.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > actions: Export a Digital Assistant to Object Storage",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/export",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Exports the specified Digital Assistant as an archive to Object Storage.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > actions: Publish Digital Assistant",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/publish",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Publish a draft Digital Assistant.\nOnce published the Digital Assistant cannot be modified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > parameters > {parameter Name}: Get Digital Assistant Parameter",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant."
|
|
},
|
|
"functionality": "Gets the specified Digital Assistant Parameter.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > parameters > {parameter Name}: Update Digital Assistant Parameter",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant."
|
|
},
|
|
"functionality": "Updates the specified Digital Assistant Parameter with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > parameters: List Digital Assistant Parameters",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Returns a page of Parameters that belong to the specified Digital Assistant.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id}: Delete Digital Assistant",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Delete the specified Digital Assistant.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id}: Get Digital Assistant",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Gets the specified Digital Assistant.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id}: Update Digital Assistant",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Updates the specified Digital Assistant with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants: List Digital Assistants",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants: Create Digital Assistant",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/digitalAssistants",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Digital Assistant.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages > {package Id}: Delete Package from Digital Assistant Instance",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/importedPackages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to delete a package from a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages > {package Id}: Get details for a package that has been imported into the given instance.",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/importedPackages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Returns a list of summaries for imported packages in the instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages > {package Id}: Update Package that has been imported into a Digital Assistant Instance",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/importedPackages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"isReplaceSkills": "boolean: Should old skills be replaced by new skills if packageId differs from already imported package?",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to update a package within a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages: List packages that have been imported into the given instance.",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/importedPackages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a list of summaries for imported packages in the instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages: Import Package into Digital Assistant Instance",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/importedPackages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to import a package into a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > actions: Export a Skill to Object Storage",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills/{skillId}/actions/export",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Exports the specified Skill as an archive to Object Storage.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > actions: Publish Skill",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills/{skillId}/actions/publish",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Publish a draft Skill.\nOnce published it cannot be modified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters > {parameter Name}: Delete Skill Parameter",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Skill Parameter."
|
|
},
|
|
"functionality": "Delete the specified Skill Parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters > {parameter Name}: Get Skill Parameter",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Skill Parameter."
|
|
},
|
|
"functionality": "Gets the specified Skill Parameter.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters > {parameter Name}: Update Skill Parameter",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Skill Parameter."
|
|
},
|
|
"functionality": "Updates the specified Skill Parameter with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters: List Skill Parameters",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills/{skillId}/parameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Returns a page of Skill Parameters that belong to the specified Skill.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters: Create Skill Parameter",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills/{skillId}/parameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Creates a new Skill Parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id}: Delete Skill",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/skills/{skillId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Delete the specified Skill.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id}: Get Skill",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills/{skillId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Gets the specified Skill.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id}: Update Skill",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/skills/{skillId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Updates the specified Skill with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills: List Skills",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Skills that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills: Create Skill",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Skill from scratch.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators > {translator Id}: Delete Translator",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/translators/{translatorId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"translatorId": "[REQUIRED] string: (Required) Unique Translator identifier."
|
|
},
|
|
"functionality": "Delete the specified Translator.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators > {translator Id}: Get Translator",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/translators/{translatorId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"translatorId": "[REQUIRED] string: (Required) Unique Translator identifier."
|
|
},
|
|
"functionality": "Gets the specified Translator.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators > {translator Id}: Update Translator",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/translators/{translatorId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"translatorId": "[REQUIRED] string: (Required) Unique Translator identifier."
|
|
},
|
|
"functionality": "Updates the specified Translator with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators: List Translators",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/translators",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Translators that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators: Create Translator",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/translators",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Translator\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Delete Digital Assistant Instance",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to delete the specified Digital Assistant instance.\nTo monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Get Digital Assistant Instance",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Gets the specified Digital Assistant instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Update Digital Assistant Instance",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Updates the specified Digital Assistant instance with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Get details for a given package",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/packages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Returns details about a package, and how to import it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances: Get Compartment's Digital Assistant Instances",
|
|
"api_call": "GET /odaInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) List the Digital Assistant instances that belong to this compartment.",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending)."
|
|
},
|
|
"functionality": "Returns a page of Digital Assistant instances that belong to the specified\ncompartment.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances: Create Digital Assistant Instance",
|
|
"api_call": "POST /odaInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Starts an asynchronous job to create a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests > {work Request Id}: Get Work Request",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The identifier of the asynchronous work request."
|
|
},
|
|
"functionality": "Gets information about the work request with the specified ID, including its status.\n\nYou can use this operation to monitor the status of jobs that you\nrequested to create, delete, and update instances.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests > {work Request Id}: List Work Request Errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.\n\nThe default sort order for both `TIMESTAMP` and `CODE` is ascending.\n",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The identifier of the asynchronous work request."
|
|
},
|
|
"functionality": "Returns a page of errors for the specified work request.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests > {work Request Id}: List Work Request Log Messages",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.\n\nThe default sort order for both `TIMESTAMP` and `MESSAGE` is ascending.\n",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The identifier of the asynchronous work request."
|
|
},
|
|
"functionality": "Returns a page of of log messages for a given work request.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests: List Compartment's Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) List the Digital Assistant instances that belong to this compartment."
|
|
},
|
|
"functionality": "Returns a page of work requests for the specified compartment.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - General: List packages available for import",
|
|
"api_call": "GET /packages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "string: List only the information for this Digital Assistant instance."
|
|
},
|
|
"functionality": "Returns a page of summaries for packages that are available for import. The optional odaInstanceId query\nparameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId\nquery parameter is not provided, the returned list will\ninclude packages available within the region indicated by the request URL. The optional resourceType query\nparam may be specified to filter packages that contain the indicated resource type. If no resourceType query\nparam is given, packages containing all resource types will be returned. The optional name query parameter can\nbe used to limit the list to packages whose name matches the given name. The optional displayName query\nparameter can be used to limit the list to packages whose displayName matches the given name. The optional\nisLatestVersionOnly query parameter can be used to limit the returned list to include only the latest version\nof any given package. If not specified, all versions of any otherwise matching package will be returned.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Document Understanding API - processor Jobs > {processor Job Id}: Get the details of a processor job.",
|
|
"api_call": "GET /processorJobs/{processorJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"processorJobId": "[REQUIRED] string: (Required) Processor job id."
|
|
},
|
|
"functionality": "Get the details of a processor job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Document Understanding API - processor Jobs > {processor Job Id}: Cancel a processor job.",
|
|
"api_call": "POST /processorJobs/{processorJobId}/actions/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"processorJobId": "[REQUIRED] string: (Required) Processor job id."
|
|
},
|
|
"functionality": "Cancel a processor job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Document Understanding API - processor Jobs: Create a processor job for document analysis.",
|
|
"api_call": "POST /processorJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a processor job for document analysis.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Retrieves a rule",
|
|
"api_call": "GET /rules/{ruleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Retrieves a rule.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Updates a rule",
|
|
"api_call": "PUT /rules/{ruleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Updates a rule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Deletes a rule",
|
|
"api_call": "DELETE /rules/{ruleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Deletes a rule.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Moves a rule into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"api_call": "POST /rules/{ruleId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Moves a rule into a different compartment within the same tenancy. For information about moving \nresources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules: Lists rules for this compartment.",
|
|
"api_call": "GET /rules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs.\n",
|
|
"limit": "integer: The maximum number of items to return. 1 is the minimum, 50 is the maximum.\nDefault: 10\n",
|
|
"lifecycleState": "string: A filter to return only rules that match the lifecycle state in this parameter.\n\nExample: `Creating`\n",
|
|
"sortBy": "string: Specifies the attribute with which to sort the rules.\n\nDefault: `timeCreated`\n\n* **TIME_CREATED:** Sorts by timeCreated.\n* **DISPLAY_NAME:** Sorts by displayName.\n* **ID:** Sorts by id.\n",
|
|
"sortOrder": "string: Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n"
|
|
},
|
|
"functionality": "Lists rules for this compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules: Creates a new rule",
|
|
"api_call": "POST /rules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new rule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Retrieves an application",
|
|
"api_call": "GET /applications/{applicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Retrieves an application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Modifies an application",
|
|
"api_call": "PUT /applications/{applicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Modifies an application",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Deletes an application",
|
|
"api_call": "DELETE /applications/{applicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Deletes an application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"api_call": "POST /applications/{applicationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Moves an application into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see [Moving Resources Between Compartments](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications: Lists applications for a compartment",
|
|
"api_call": "GET /applications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this resource belongs.\n",
|
|
"limit": "integer: The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n",
|
|
"sortOrder": "string: Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n",
|
|
"sortBy": "string: Specifies the attribute with which to sort the rules.\n\nDefault: `displayName`\n\n* **timeCreated:** Sorts by timeCreated.\n* **displayName:** Sorts by displayName.\n* **id:** Sorts by id.\n"
|
|
},
|
|
"functionality": "Lists applications for a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications: Creates a new application",
|
|
"api_call": "POST /applications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string"
|
|
},
|
|
"functionality": "Creates a new application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Retrieves a function",
|
|
"api_call": "GET /functions/{functionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Retrieves a function.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Modifies a function",
|
|
"api_call": "PUT /functions/{functionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Modifies a function",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Deletes a function",
|
|
"api_call": "DELETE /functions/{functionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Deletes a function.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Invokes a function",
|
|
"api_call": "POST //<unique_ID>.{region}.functions.oci.oraclecloud.com/20181201/functions/{functionId}/actions/invoke",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"region": "[REQUIRED] string",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Invokes a function",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions: Lists functions for an application",
|
|
"api_call": "GET /functions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"applicationId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application to which this function belongs.\n",
|
|
"limit": "integer: The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n",
|
|
"page": "string: The pagination token for a list query returned by a previous operation\n",
|
|
"sortOrder": "string: Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n",
|
|
"sortBy": "string: Specifies the attribute with which to sort the rules.\n\nDefault: `displayName`\n\n* **timeCreated:** Sorts by timeCreated.\n* **displayName:** Sorts by displayName.\n* **id:** Sorts by id.\n"
|
|
},
|
|
"functionality": "Lists functions for an application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions: Creates a new function",
|
|
"api_call": "POST /functions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string"
|
|
},
|
|
"functionality": "Creates a new function.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - actions > embedText: Produces embeddings (i.e. low-level numerical representation) of the inputs",
|
|
"api_call": "POST /actions/embedText",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**EmbedText**\n\nProduces embeddings (low-level numerical representation) of the inputs\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - actions > generateText: Generates text response based on the prompts",
|
|
"api_call": "POST /actions/generateText",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GenerateText**\n\nGenerates text response based on the prompts\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - actions > summarizeText: Summarizes text response based on the input",
|
|
"api_call": "POST /actions/summarizeText",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**SummarizeText**\n\nSummarizes text response based on the input\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId} > actions > changeCompartment: Moves a DedicatedAiCluster into a different compartment.",
|
|
"api_call": "POST /dedicatedAiClusters/{dedicatedAiClusterId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ChangeDedicatedAiClusterCompartment**\n\nMoves a dedicated AI cluster into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId}: Deletes a dedicated AI cluster.",
|
|
"api_call": "DELETE /dedicatedAiClusters/{dedicatedAiClusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**DeleteDedicatedAiCluster**\n\nDeletes a dedicated AI cluster.\n\nYou can only delete clusters without attached resources. Before you delete a dedicated AI cluster, you must delete the hosted models or endpoints attached to that cluster. The delete action permanently deletes the cluster. This action can't be undone.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId}: Get DedicatedAiCluster",
|
|
"api_call": "GET /dedicatedAiClusters/{dedicatedAiClusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetDedicatedAiCluster**\n\nGets information about a dedicated AI cluster.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId}: Updates a DedicatedAiCluster.",
|
|
"api_call": "PUT /dedicatedAiClusters/{dedicatedAiClusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**UpdateDedicatedAiCluster**\n\nUpdates a dedicated AI cluster.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters: Gets a list of DedicatedAiClusters.",
|
|
"api_call": "GET /dedicatedAiClusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"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`\nis descending. Default order for `displayName` is ascending.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListDedicatedAiClusters**\n\nLists the dedicated AI clusters in a specific compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters: Creates a DedicatedAiCluster.",
|
|
"api_call": "POST /dedicatedAiClusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**CreateDedicatedAiCluster**\n\nCreates a dedicated AI cluster.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId} > actions > changeCompartment: Moves an endpoint into a different compartment.",
|
|
"api_call": "POST /endpoints/{endpointId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ChangeEndpointCompartment**\n\nMoves an endpoint into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId}: Deletes an endpoint.",
|
|
"api_call": "DELETE /endpoints/{endpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**DeleteEndpoint**\n\nDeletes an endpoint.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId}: Get Endpoint",
|
|
"api_call": "GET /endpoints/{endpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetEndpoint**\n\nGets information about an endpoint.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId}: Updates a Endpoint.",
|
|
"api_call": "PUT /endpoints/{endpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**UpdateEndpoint**\n\nUpdates the properties of an endpoint.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints: Gets a list of Endpoints.",
|
|
"api_call": "GET /endpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"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`\nis descending. Default order for `displayName` is ascending.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListEndpoints**\n\nList the endpoints of a specific compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints: Creates a Endpoint.",
|
|
"api_call": "POST /endpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**CreateEndpoint**\n\nCreates an endpoint.\nHeaders contain opc-work-request-id that identifies a WorkRequest which tracks the Endpoint creation progress.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId} > actions > changeCompartment: Moves a Model into a different compartment.",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ChangeModelCompartment**\n\nMoves a custom model into a different compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId}: Deletes a Model.",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**DeleteModel**\n\nDeletes a custom model. A model shouldn't be deleted if there's one or more active endpoints associated with the model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId}: Retrieves a single model resource, providing basic information about the model",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetModel**\n\nGets information about a custom model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId}: Updates a Model.",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**UpdateModel**\n\nUpdates the properties of a custom model such as name, description, freeform tags and defined tags.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models: Lists the currently available models.",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"capability": "string: A filter to return only resources their capability matches the given capability.",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"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.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListModels**\n\nLists the models in a specific compartment. Includes both pretrained base models and fine-tuned custom models.\nModelCollection is to conform to OCI API consistency guidelines.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models: Creates a Model.",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**CreateModel**\n\nCreates a custom model to use for fine-tuning. \n\nHeaders contain opc-work-request-id that identifies a WorkRequest which tracks the Model creation progress.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests > {workRequestId} > errors: List work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListWorkRequestErrors**\n\nLists the errors for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests > {workRequestId} > logs: Lists the work request logs.",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListWorkRequestLogs**\n\nLists the logs for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests > {workRequestId}: Get work request status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetWorkRequest**\n\nGets the details of a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests: List work requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListWorkRequests**\n\nLists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - authentication Policies/{compartment Id}: GetAuthenticationPolicy",
|
|
"api_call": "GET /authenticationPolicies/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Gets the authentication policy for the given tenancy. You must specify your tenant\u2019s OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - authentication Policies/{compartment Id}: UpdateAuthenticationPolicy",
|
|
"api_call": "PUT /authenticationPolicies/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Updates authentication policy for the specified tenancy\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: Bulk delete resources in the compartment",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/bulkDeleteResources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate\npermissions to delete the resources in the request. This API can only be invoked from the tenancy's\n[home region](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingregions.htm#Home). This operation creates a\n[WorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/). Use the [GetWorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest)\nAPI to monitor the status of the bulk action.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: Move multiple resources at once to a different compartment.",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/bulkMoveResources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Moves multiple resources from one compartment to another. All resources must be in the same compartment.\nThis API can only be invoked from the tenancy's [home region](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingregions.htm#Home).\nTo move resources, you must have the appropriate permissions to move the resource in both the source and target\ncompartments. This operation creates a [WorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/).\nUse the [GetWorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) API to monitor the status of the bulk action.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: Moves a compartment tree to a different parent compartment. When provided,\nIf-Match is checked against ETag values of the resource.\n",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/moveCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Move the compartment to a different parent compartment in the same tenancy. When you move a\ncompartment, all its contents (subcompartments and resources) are moved with it. Note that\nthe `CompartmentId` that you specify in the path is the compartment that you want to move.\n\n**IMPORTANT**: After you move a compartment to a new parent compartment, the access policies of\nthe new parent take effect and the policies of the previous parent no longer apply. Ensure that you\nare aware of the implications for the compartment contents before you move it. For more\ninformation, see [Moving a Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#MoveCompartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: RecoverCompartment",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/recoverCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Recover the compartment from DELETED state to ACTIVE state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id}: DeleteCompartment",
|
|
"api_call": "DELETE /compartments/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Deletes the specified compartment. The compartment must be empty.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id}: GetCompartment",
|
|
"api_call": "GET /compartments/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Gets the specified compartment's information.\n\nThis operation does not return a list of all the resources inside the compartment. There is no single\nAPI operation that does that. Compartments can contain multiple types of resources (instances, block\nstorage volumes, etc.). To find out what's in a compartment, you must call the \"List\" operation for\neach resource type and specify the compartment's OCID as a query parameter in the request. For example,\ncall the [ListInstances](https://docs.oracle.com/iaas/api/#/en/iaas/20160918/Instance/ListInstances) operation in the Cloud Compute\nService or the [ListVolumes](https://docs.oracle.com/iaas/api/#/en/iaas/20160918/Volume/ListVolumes) operation in Cloud Block Storage.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id}: UpdateCompartment",
|
|
"api_call": "PUT /compartments/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Updates the specified compartment's description or name. You can't update the root compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments: ListCompartments",
|
|
"api_call": "GET /compartments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"accessLevel": "string: Valid values are `ANY` and `ACCESSIBLE`. Default is `ANY`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). For the compartments on which the user indirectly has\nINSPECT permissions, a restricted set of fields is returned.\n\nWhen set to `ANY` permissions are not checked.\n",
|
|
"compartmentIdInSubtree": "boolean: Default is false. Can only be set to true when performing\nListCompartments on the tenancy (root compartment).\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the the setting of `accessLevel`.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the compartments in a specified compartment. The members of the list\nreturned depends on the values set for several parameters.\n\nWith the exception of the tenancy (root compartment), the ListCompartments operation\nreturns only the first-level child compartments in the parent compartment specified in\n`compartmentId`. The list does not include any subcompartments of the child\ncompartments (grandchildren).\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (the resource can be in a subcompartment).\n\nThe parameter `compartmentIdInSubtree` applies only when you perform ListCompartments on the\ntenancy (root compartment). When set to true, the entire hierarchy of compartments can be returned.\nTo get a full list of all compartments and subcompartments in the tenancy (root compartment),\nset the parameter `compartmentIdInSubtree` to true and `accessLevel` to ANY.\n\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments: CreateCompartment",
|
|
"api_call": "POST /compartments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new compartment in the specified compartment.\n\n**Important:** Compartments cannot be deleted.\n\nSpecify the parent compartment's OCID as the compartment ID in the request object. Remember that the tenancy\nis simply the root compartment. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the compartment, which must be unique across all compartments in\nyour tenancy. You can use this name or the OCID when writing policies that apply\nto the compartment. For more information about policies, see\n[How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the compartment (although it can be an empty string). It does\nnot have to be unique, and you can change it anytime with\n[UpdateCompartment](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Compartment/UpdateCompartment).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments: ListBulkActionResourceTypes",
|
|
"api_call": "GET /compartments/bulkActionResourceTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bulkActionType": "string: (Required) The type of bulk action.\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the resource-types supported by compartment bulk actions. Use this API to help you provide the correct\nresource-type information to the [BulkDeleteResources](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Compartment/BulkDeleteResources/)\nand [BulkMoveResources](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Compartment/BulkMoveResources/) operations. The returned list of\nresource-types provides the appropriate resource-type names to use with the bulk action operations along with\nthe type of identifying information you'll need to provide for each resource-type. Most resource-types just\nrequire an [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) to identify a specific resource, but some resource-types,\nsuch as buckets, require you to provide other identifying information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups > {dynamic Group Id}: DeleteDynamicGroup",
|
|
"api_call": "DELETE /dynamicGroups/{dynamicGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dynamicGroupId": "[REQUIRED] string: (Required) The OCID of the dynamic group."
|
|
},
|
|
"functionality": "Deletes the specified dynamic group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups > {dynamic Group Id}: GetDynamicGroup",
|
|
"api_call": "GET /dynamicGroups/{dynamicGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dynamicGroupId": "[REQUIRED] string: (Required) The OCID of the dynamic group."
|
|
},
|
|
"functionality": "Gets the specified dynamic group's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups > {dynamic Group Id}: UpdateDynamicGroup",
|
|
"api_call": "PUT /dynamicGroups/{dynamicGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dynamicGroupId": "[REQUIRED] string: (Required) The OCID of the dynamic group."
|
|
},
|
|
"functionality": "Updates the specified dynamic group.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups: ListDynamicGroups",
|
|
"api_call": "GET /dynamicGroups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the dynamic groups in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups: CreateDynamicGroup",
|
|
"api_call": "POST /dynamicGroups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new dynamic group in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the dynamic group, which must be unique across all dynamic groups in your\ntenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy.\nYou can use this name or the OCID when writing policies that apply to the dynamic group. For more information\nabout policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the dynamic group (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdateDynamicGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/DynamicGroup/UpdateDynamicGroup).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups > {group Id}: DeleteGroup",
|
|
"api_call": "DELETE /groups/{groupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"groupId": "[REQUIRED] string: (Required) The OCID of the group."
|
|
},
|
|
"functionality": "Deletes the specified group. The group must be empty.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups > {group Id}: GetGroup",
|
|
"api_call": "GET /groups/{groupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"groupId": "[REQUIRED] string: (Required) The OCID of the group."
|
|
},
|
|
"functionality": "Gets the specified group's information.\n\nThis operation does not return a list of all the users in the group. To do that, use\n[ListUserGroupMemberships](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UserGroupMembership/ListUserGroupMemberships) and\nprovide the group's OCID as a query parameter in the request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups > {group Id}: UpdateGroup",
|
|
"api_call": "PUT /groups/{groupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"groupId": "[REQUIRED] string: (Required) The OCID of the group."
|
|
},
|
|
"functionality": "Updates the specified group.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups: ListGroups",
|
|
"api_call": "GET /groups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the groups in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups: CreateGroup",
|
|
"api_call": "POST /groups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new group in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the group, which must be unique across all groups in your tenancy and\ncannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more\ninformation about policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the group (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdateGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Group/UpdateGroup).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n\nAfter creating the group, you need to put users in it and write policies for it.\nSee [AddUserToGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UserGroupMembership/AddUserToGroup) and\n[CreatePolicy](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Policy/CreatePolicy).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings > {mapping Id}: DeleteIdpGroupMapping",
|
|
"api_call": "DELETE /identityProviders/{identityProviderId}/groupMappings/{mappingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider.",
|
|
"mappingId": "[REQUIRED] string: (Required) The OCID of the group mapping."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nDeletes the specified group mapping.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings > {mapping Id}: GetIdpGroupMapping",
|
|
"api_call": "GET /identityProviders/{identityProviderId}/groupMappings/{mappingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider.",
|
|
"mappingId": "[REQUIRED] string: (Required) The OCID of the group mapping."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nGets the specified group mapping.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings > {mapping Id}: UpdateIdpGroupMapping",
|
|
"api_call": "PUT /identityProviders/{identityProviderId}/groupMappings/{mappingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider.",
|
|
"mappingId": "[REQUIRED] string: (Required) The OCID of the group mapping."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nUpdates the specified group mapping.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings: ListIdpGroupMappings",
|
|
"api_call": "GET /identityProviders/{identityProviderId}/groupMappings/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists the group mappings for the specified identity provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings: CreateIdpGroupMapping",
|
|
"api_call": "POST /identityProviders/{identityProviderId}/groupMappings/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nCreates a single mapping between an IdP group and an IAM Service\n[group](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Group/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: DeleteIdentityProvider",
|
|
"api_call": "DELETE /identityProviders/{identityProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nDeletes the specified identity provider. The identity provider must not have\nany group mappings (see [IdpGroupMapping](https://docs.oracle.com/iaas/api/#/en/identity/20160918/IdpGroupMapping/)).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: GetIdentityProvider",
|
|
"api_call": "GET /identityProviders/{identityProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nGets the specified identity provider's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: UpdateIdentityProvider",
|
|
"api_call": "PUT /identityProviders/{identityProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nUpdates the specified identity provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: ResetIdpScimClient",
|
|
"api_call": "POST /identityProviders/{identityProviderId}/actions/resetScimClient/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: Gets the identity provider groups.",
|
|
"api_call": "GET /identityProviders/{identityProviderId}/groups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"name": "string: A filter to only return resources that match the given name exactly.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists the identity provider groups.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers: ListIdentityProviders",
|
|
"api_call": "GET /identityProviders/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"protocol": "string: (Required) The protocol used for federation.",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for\nidentity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the\ncompartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers: CreateIdentityProvider",
|
|
"api_call": "POST /identityProviders/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nCreates a new identity provider in your tenancy. For more information, see\n[Identity Providers and Federation](https://docs.oracle.com/iaas/Content/Identity/Concepts/federation.htm).\n\nYou must specify your tenancy's OCID as the compartment ID in the request object.\nRemember that the tenancy is simply the root compartment. For information about\nOCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the `IdentityProvider`, which must be unique\nacross all `IdentityProvider` objects in your tenancy and cannot be changed.\n\nYou must also specify a *description* for the `IdentityProvider` (although\nit can be an empty string). It does not have to be unique, and you can change\nit anytime with\n[UpdateIdentityProvider](https://docs.oracle.com/iaas/api/#/en/identity/20160918/IdentityProvider/UpdateIdentityProvider).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily\nbe CREATING. Before using the object, first make sure its `lifecycleState` has\nchanged to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources > {network Source Id}: DeleteNetworkSource",
|
|
"api_call": "DELETE /networkSources/{networkSourceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSourceId": "[REQUIRED] string: (Required) The OCID of the network source."
|
|
},
|
|
"functionality": "Deletes the specified network source\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources > {network Source Id}: GetNetworkSource",
|
|
"api_call": "GET /networkSources/{networkSourceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSourceId": "[REQUIRED] string: (Required) The OCID of the network source."
|
|
},
|
|
"functionality": "Gets the specified network source's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources > {network Source Id}: UpdateNetworkSource",
|
|
"api_call": "PUT /networkSources/{networkSourceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSourceId": "[REQUIRED] string: (Required) The OCID of the network source."
|
|
},
|
|
"functionality": "Updates the specified network source.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources: ListNetworkSources",
|
|
"api_call": "GET /networkSources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the network sources in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources: CreateNetworkSource",
|
|
"api_call": "POST /networkSources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new network source in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the network source, which must be unique across all network sources in your\ntenancy, and cannot be changed.\nYou can use this name or the OCID when writing policies that apply to the network source. For more information\nabout policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the network source (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdateNetworkSource](https://docs.oracle.com/iaas/api/#/en/identity/20160918/NetworkSource/UpdateNetworkSource).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n\nAfter your network resource is created, you can use it in policy to restrict access to only requests made from an allowed\nIP address specified in your network source. For more information, see [Managing Network Sources](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingnetworksources.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies > {policy Id}: DeletePolicy",
|
|
"api_call": "DELETE /policies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the policy."
|
|
},
|
|
"functionality": "Deletes the specified policy. The deletion takes effect typically within 10 seconds.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies > {policy Id}: GetPolicy",
|
|
"api_call": "GET /policies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the policy."
|
|
},
|
|
"functionality": "Gets the specified policy's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies > {policy Id}: UpdatePolicy",
|
|
"api_call": "PUT /policies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the policy."
|
|
},
|
|
"functionality": "Updates the specified policy. You can update the description or the policy statements themselves.\n\nPolicy changes take effect typically within 10 seconds.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies: ListPolicies",
|
|
"api_call": "GET /policies/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the policies in the specified compartment (either the tenancy or another of your compartments).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n\nTo determine which policies apply to a particular group or compartment, you must view the individual\nstatements inside all your policies. There isn't a way to automatically obtain that information via the API.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies: CreatePolicy",
|
|
"api_call": "POST /policies/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new policy in the specified compartment (either the tenancy or another of your compartments).\nIf you're new to policies, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n\nYou must specify a *name* for the policy, which must be unique across all policies in your tenancy\nand cannot be changed.\n\nYou must also specify a *description* for the policy (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdatePolicy](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Policy/UpdatePolicy).\n\nYou must specify one or more policy statements in the statements array. For information about writing\npolicies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm) and\n[Common Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/commonpolicies.htm).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n\nNew policies take effect typically within 10 seconds.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults > {tag Default Id}: DeleteTagDefault",
|
|
"api_call": "DELETE /tagDefaults/{tagDefaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagDefaultId": "[REQUIRED] string: (Required) The OCID of the tag default."
|
|
},
|
|
"functionality": "Deletes the the specified tag default.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults > {tag Default Id}: GetTagDefault",
|
|
"api_call": "GET /tagDefaults/{tagDefaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagDefaultId": "[REQUIRED] string: (Required) The OCID of the tag default."
|
|
},
|
|
"functionality": "Retrieves the specified tag default.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults > {tag Default Id}: UpdateTagDefault",
|
|
"api_call": "PUT /tagDefaults/{tagDefaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagDefaultId": "[REQUIRED] string: (Required) The OCID of the tag default."
|
|
},
|
|
"functionality": "Updates the specified tag default. If you specify that a value is required, a value is set\nduring resource creation (either by the user creating the resource or another tag defualt).\nIf no value is set, resource creation is blocked.\n\n* If the `isRequired` flag is set to \"true\", the value is set during resource creation.\n* If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults: ListTagDefaults",
|
|
"api_call": "GET /tagDefaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"compartmentId": "string: The OCID of the compartment (remember that the tenancy is simply the root compartment).\n"
|
|
},
|
|
"functionality": "Lists the tag defaults for tag definitions in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults: CreateTagDefault",
|
|
"api_call": "POST /tagDefaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new tag default in the specified compartment for the specified tag definition.\n\nIf you specify that a value is required, a value is set during resource creation (either by\nthe user creating the resource or another tag defualt). If no value is set, resource creation\nis blocked.\n\n* If the `isRequired` flag is set to \"true\", the value is set during resource creation.\n* If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults: AssembleEffectiveTagSet",
|
|
"api_call": "GET /tagDefaults/actions/assembleEffectiveTagSet",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n"
|
|
},
|
|
"functionality": "Assembles tag defaults in the specified compartment and any parent compartments to determine\nthe tags to apply. Tag defaults from parent compartments do not override tag defaults\nreferencing the same tag in a compartment lower down the hierarchy. This set of tag defaults\nincludes all tag defaults from the current compartment back to the root compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > actions: Delete tag namespace that contains tags",
|
|
"api_call": "POST /tagNamespaces/{tagNamespaceId}/actions/cascadeDelete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Deletes the specified tag namespace. This operation triggers a process that removes all of the tags\ndefined in the specified tag namespace from all resources in your tenancy and then deletes the tag namespace.\n\nAfter you start the delete operation:\n\n * New tag key definitions cannot be created under the namespace.\n * The state of the tag namespace changes to DELETING.\n * Tag removal from the resources begins.\n\nThis process can take up to 48 hours depending on the number of tag definitions in the namespace, the number of resources\nthat are tagged, and the locations of the regions in which those resources reside.\n\nAfter all tags are removed, the state changes to DELETED. You cannot restore a deleted tag namespace. After the deleted tag namespace\nchanges its state to DELETED, you can use the name of the deleted tag namespace again.\n\nAfter you start this operation, you cannot start either the [DeleteTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/DeleteTag) or the [BulkDeleteTags](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/BulkDeleteTags) operation until this process completes.\n\nTo delete a tag namespace, you must first retire it. Use [UpdateTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/UpdateTagNamespace)\nto retire a tag namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > actions: changes compartment of a tag namespace.",
|
|
"api_call": "POST /tagNamespaces/{tagNamespaceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Moves the specified tag namespace to the specified compartment within the same tenancy.\n\nTo move the tag namespace, you must have the manage tag-namespaces permission on both compartments.\nFor more information about IAM policies, see [Details for IAM](https://docs.oracle.com/iaas/Content/Identity/Reference/iampolicyreference.htm).\n\nMoving a tag namespace moves all the tag key definitions contained in the tag namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags > {tag Name}: DeleteTag",
|
|
"api_call": "DELETE /tagNamespaces/{tagNamespaceId}/tags/{tagName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n",
|
|
"tagName": "[REQUIRED] string: (Required) The name of the tag.\n"
|
|
},
|
|
"functionality": "Deletes the specified tag definition. This operation triggers a process that removes the\ntag from all resources in your tenancy.\n\nThese things happen immediately:\n\u00a0\n * If the tag was a cost-tracking tag, it no longer counts against your 10 cost-tracking\n tags limit, whether you first disabled it or not.\n * If the tag was used with dynamic groups, none of the rules that contain the tag will\n be evaluated against the tag.\n\nWhen you start the delete operation, the state of the tag changes to DELETING and tag removal\nfrom resources begins. This can take up to 48 hours depending on the number of resources that\nwere tagged as well as the regions in which those resources reside.\n\nWhen all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. Once the deleted tag\nchanges its state to DELETED, you can use the same tag name again.\n\nAfter you start this operation, you cannot start either the [BulkDeleteTags](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/BulkDeleteTags) or the [CascadeDeleteTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) operation until this process completes.\n\nTo delete a tag, you must first retire it. Use [UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/latest/Tag/UpdateTag)\nto retire a tag.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags > {tag Name}: GetTag",
|
|
"api_call": "GET /tagNamespaces/{tagNamespaceId}/tags/{tagName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n",
|
|
"tagName": "[REQUIRED] string: (Required) The name of the tag.\n"
|
|
},
|
|
"functionality": "Gets the specified tag's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags > {tag Name}: UpdateTag",
|
|
"api_call": "PUT /tagNamespaces/{tagNamespaceId}/tags/{tagName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n",
|
|
"tagName": "[REQUIRED] string: (Required) The name of the tag.\n"
|
|
},
|
|
"functionality": "Updates the specified tag definition.\n\nSetting `validator` determines the value type. Tags can use either a static value or a\nlist of possible values. Static values are entered by a user applying the tag to a resource.\nLists are created by you and the user must apply a value from the list. On update, any values\nin a list that were previously set do not change, but new values must pass validation. Values\nalready applied to a resource do not change.\n\nYou cannot remove list values that appear in a TagDefault. To remove a list value that\nappears in a TagDefault, first update the TagDefault to use a different value.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags: ListTags",
|
|
"api_call": "GET /tagNamespaces/{tagNamespaceId}/tags",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Lists the tag definitions in the specified tag namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags: CreateTag",
|
|
"api_call": "POST /tagNamespaces/{tagNamespaceId}/tags",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Creates a new tag in the specified tag namespace.\n\nThe tag requires either the OCID or the name of the tag namespace that will contain this\ntag definition.\n\nYou must specify a *name* for the tag, which must be unique across all tags in the tag namespace\nand cannot be changed. The name can contain any ASCII character except the space (_) or period (.) characters.\nNames are case insensitive. That means, for example, \"myTag\" and \"mytag\" are not allowed in the same namespace.\nIf you specify a name that's already in use in the tag namespace, a 409 error is returned.\n\nThe tag must have a *description*. It does not have to be unique, and you can change it with\n[UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/latest/Tag/UpdateTag).\n\nThe tag must have a value type, which is specified with a validator. Tags can use either a\nstatic value or a list of possible values. Static values are entered by a user applying the tag\nto a resource. Lists are created by you and the user must apply a value from the list. Lists\nare validiated.\n\n* If no `validator` is set, the user applying the tag to a resource can type in a static\nvalue or leave the tag value empty.\n* If a `validator` is set, the user applying the tag to a resource must select from a list\nof values that you supply with [EnumTagDefinitionValidator](https://docs.oracle.com/iaas/api/#/en/identity/latest/datatypes/EnumTagDefinitionValidator).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id}: DeleteTagNamespace",
|
|
"api_call": "DELETE /tagNamespaces/{tagNamespaceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Deletes the specified tag namespace. Only an empty tag namespace can be deleted with this operation. To use this operation\nto delete a tag namespace that contains tag definitions, first delete all of its tag definitions.\n\nUse [CascadeDeleteTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) to delete a tag namespace along with all of\nthe tag definitions contained within that namespace.\n\nUse [DeleteTag](https://docs.oracle.com/iaas/api/#/en/identity/latest/Tag/DeleteTag) to delete a tag definition.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id}: GetTagNamespace",
|
|
"api_call": "GET /tagNamespaces/{tagNamespaceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Gets the specified tag namespace's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id}: UpdateTagNamespace",
|
|
"api_call": "PUT /tagNamespaces/{tagNamespaceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Updates the the specified tag namespace. You can't update the namespace name.\n\nUpdating `isRetired` to 'true' retires the namespace and all the tag definitions in the namespace. Reactivating a\nnamespace (changing `isRetired` from 'true' to 'false') does not reactivate tag definitions.\nTo reactivate the tag definitions, you must reactivate each one individually *after* you reactivate the namespace,\nusing [UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/UpdateTag). For more information about retiring tag namespaces, see\n[Retiring Key Definitions and Namespace Definitions](https://docs.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#Retiring).\n\nYou can't add a namespace with the same name as a retired namespace in the same tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces: ListTagNamespaces",
|
|
"api_call": "GET /tagNamespaces",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"includeSubcompartments": "boolean: An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this\nparameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.\n"
|
|
},
|
|
"functionality": "Lists the tag namespaces in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces: CreateTagNamespace",
|
|
"api_call": "POST /tagNamespaces",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new tag namespace in the specified compartment.\n\nYou must specify the compartment ID in the request object (remember that the tenancy is simply the root\ncompartment).\n\nYou must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy\nand cannot be changed. The name can contain any ASCII character except the space (_) or period (.).\nNames are case insensitive. That means, for example, \"myNamespace\" and \"mynamespace\" are not allowed\nin the same tenancy. Once you created a namespace, you cannot change the name.\nIf you specify a name that's already in use in the tenancy, a 409 error is returned.\n\nYou must also specify a *description* for the namespace.\nIt does not have to be unique, and you can change it with\n[UpdateTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/latest/TagNamespace/UpdateTagNamespace).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces: ListCostTrackingTags",
|
|
"api_call": "GET /tagNamespaces/actions/listCostTrackingTags",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists all the tags enabled for cost-tracking in the specified tenancy. For information about\ncost-tracking tags, see [Using Cost-tracking Tags](https://docs.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#costs).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests > {work Request Id}: GetTaggingWorkRequest",
|
|
"api_call": "GET /taggingWorkRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header\nfor any asynchronous operation in the Identity and Access Management service.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests > {work Request Id}: ListTaggingWorkRequestErrors",
|
|
"api_call": "GET /taggingWorkRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets the errors for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests > {work Request Id}: ListTaggingWorkRequestLogs",
|
|
"api_call": "GET /taggingWorkRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets the logs for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests: ListTaggingWorkRequests",
|
|
"api_call": "GET /taggingWorkRequests/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the tagging work requests in compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tags > actions: Delete multiple tag key definitions at the same time",
|
|
"api_call": "POST /tags/actions/bulkDelete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Deletes the specified tag key definitions. This operation triggers a process that removes the\ntags from all resources in your tenancy. The tag key definitions must be within the same tag namespace.\n\nThe following actions happen immediately:\n\u00a0\n * If the tag is a cost-tracking tag, the tag no longer counts against your\n 10 cost-tracking tags limit, even if you do not disable the tag before running this operation.\n * If the tag is used with dynamic groups, the rules that contain the tag are no longer\n evaluated against the tag.\n\nAfter you start this operation, the state of the tag changes to DELETING, and tag removal\nfrom resources begins. This process can take up to 48 hours depending on the number of resources that\nare tagged and the regions in which those resources reside.\n\nWhen all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. After the tag state\nchanges to DELETED, you can use the same tag name again.\n\nAfter you start this operation, you cannot start either the [DeleteTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/DeleteTag) or the [CascadeDeleteTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) operation until this process completes.\n\nIn order to delete tags, you must first retire the tags. Use [UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/UpdateTag)\nto retire a tag.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tags > actions: Edit multiple tag key definitions on resources",
|
|
"api_call": "POST /tags/actions/bulkEdit",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Edits the specified list of tag key definitions for the selected resources. \nThis operation triggers a process that edits the tags on all selected resources. The possible actions are:\n\n * Add a defined tag when the tag does not already exist on the resource.\n * Update the value for a defined tag when the tag is present on the resource.\n * Add a defined tag when it does not already exist on the resource or update the value for a defined tag when the tag is present on the resource.\n * Remove a defined tag from a resource. The tag is removed from the resource regardless of the tag value.\n\nSee [BulkEditOperationDetails](https://docs.oracle.com/iaas/api/#/en/identity/latest/datatypes/BulkEditOperationDetails) for more information.\n\nThe edits can include a combination of operations and tag sets. \nHowever, multiple operations cannot apply to one key definition in the same request.\nFor example, if one request adds `tag set-1` to a resource and sets a tag value to `tag set-2`, \n`tag set-1` and `tag set-2` cannot have any common tag definitions.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tags: ListBulkEditTagsResourceTypes",
|
|
"api_call": "GET /tags/bulkEditResourceTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the resource types that support bulk tag editing.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tenancies/{tenancy Id} > region Subscriptions: ListRegionSubscriptions",
|
|
"api_call": "GET /tenancies/{tenancyId}/regionSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tenancyId": "[REQUIRED] string: (Required) The OCID of the tenancy."
|
|
},
|
|
"functionality": "Lists the region subscriptions for the specified tenancy.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tenancies/{tenancy Id} > region Subscriptions: CreateRegionSubscription",
|
|
"api_call": "POST /tenancies/{tenancyId}/regionSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tenancyId": "[REQUIRED] string: (Required) The OCID of the tenancy."
|
|
},
|
|
"functionality": "Creates a subscription to a region for a tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tenancies/{tenancy Id}: GetTenancy",
|
|
"api_call": "GET /tenancies/{tenancyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tenancyId": "[REQUIRED] string: (Required) The OCID of the tenancy."
|
|
},
|
|
"functionality": "Get the specified tenancy's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships > {user Group Membership Id}: RemoveUserFromGroup",
|
|
"api_call": "DELETE /userGroupMemberships/{userGroupMembershipId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userGroupMembershipId": "[REQUIRED] string: (Required) The OCID of the userGroupMembership."
|
|
},
|
|
"functionality": "Removes a user from a group by deleting the corresponding `UserGroupMembership`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships > {user Group Membership Id}: GetUserGroupMembership",
|
|
"api_call": "GET /userGroupMemberships/{userGroupMembershipId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userGroupMembershipId": "[REQUIRED] string: (Required) The OCID of the userGroupMembership."
|
|
},
|
|
"functionality": "Gets the specified UserGroupMembership's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships: ListUserGroupMemberships",
|
|
"api_call": "GET /userGroupMemberships/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"userId": "string: The OCID of the user.",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the `UserGroupMembership` objects in your tenancy. You must specify your tenancy's OCID\nas the value for the compartment ID\n(see [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five)).\nYou must also then filter the list in one of these ways:\n\n- You can limit the results to just the memberships for a given user by specifying a `userId`.\n- Similarly, you can limit the results to just the memberships for a given group by specifying a `groupId`.\n- You can set both the `userId` and `groupId` to determine if the specified user is in the specified group.\nIf the answer is no, the response is an empty list.\n- Although`userId` and `groupId` are not individually required, you must set one of them.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships: AddUserToGroup",
|
|
"api_call": "POST /userGroupMemberships/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > api Keys: ListApiKeys",
|
|
"api_call": "GET /users/{userId}/apiKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the API signing keys for the specified user. A user can have a maximum of three keys.\n\nEvery user has permission to use this API call for *their own user ID*. An administrator in your\norganization does not need to write a policy to give users this ability.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > api Keys: UploadApiKey",
|
|
"api_call": "POST /users/{userId}/apiKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Uploads an API signing key for the specified user.\n\nEvery user has permission to use this operation to upload a key for *their own user ID*. An\nadministrator in your organization does not need to write a policy to give users this ability.\nTo compare, administrators who have permission to the tenancy can use this operation to upload a\nkey for any user, including themselves.\n\n**Important:** Even though you have permission to upload an API key, you might not yet\nhave permission to do much else. If you try calling an operation unrelated to your own credential\nmanagement (e.g., `ListUsers`, `LaunchInstance`) and receive an \"unauthorized\" error,\ncheck with an administrator to confirm which IAM Service group(s) you're in and what access\nyou have. Also confirm you're working in the correct compartment.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using\nthe object, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > api Keys: DeleteApiKey",
|
|
"api_call": "DELETE /users/{userId}/apiKeys/{fingerprint}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"fingerprint": "[REQUIRED] string: (Required) The key's fingerprint."
|
|
},
|
|
"functionality": "Deletes the specified API signing key for the specified user.\n\nEvery user has permission to use this operation to delete a key for *their own user ID*. An\nadministrator in your organization does not need to write a policy to give users this ability.\nTo compare, administrators who have permission to the tenancy can use this operation to delete\na key for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens > {auth Token Id}: DeleteAuthToken",
|
|
"api_call": "DELETE /users/{userId}/authTokens/{authTokenId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"authTokenId": "[REQUIRED] string: (Required) The OCID of the auth token."
|
|
},
|
|
"functionality": "Deletes the specified auth token for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens > {auth Token Id}: UpdateAuthToken",
|
|
"api_call": "PUT /users/{userId}/authTokens/{authTokenId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"authTokenId": "[REQUIRED] string: (Required) The OCID of the auth token."
|
|
},
|
|
"functionality": "Updates the specified auth token's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens: ListAuthTokens",
|
|
"api_call": "GET /users/{userId}/authTokens/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not\nthe token itself. The actual token is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens: CreateAuthToken",
|
|
"api_call": "POST /users/{userId}/authTokens/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new auth token for the specified user. For information about what auth tokens are for, see\n[Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the auth token (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/UpdateAuthToken).\n\nEvery user has permission to create an auth token for *their own user ID*. An administrator in your organization\ndoes not need to write a policy to give users this ability. To compare, administrators who have permission to the\ntenancy can use this operation to create an auth token for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys > {customer Secret Key Id}: DeleteCustomerSecretKey",
|
|
"api_call": "DELETE /users/{userId}/customerSecretKeys/{customerSecretKeyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"customerSecretKeyId": "[REQUIRED] string: (Required) The OCID of the secret key."
|
|
},
|
|
"functionality": "Deletes the specified secret key for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys > {customer Secret Key Id}: UpdateCustomerSecretKey",
|
|
"api_call": "PUT /users/{userId}/customerSecretKeys/{customerSecretKeyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"customerSecretKeyId": "[REQUIRED] string: (Required) The OCID of the secret key."
|
|
},
|
|
"functionality": "Updates the specified secret key's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys: ListCustomerSecretKeys",
|
|
"api_call": "GET /users/{userId}/customerSecretKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not\nthe secret key itself. The actual secret key is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys: CreateCustomerSecretKey",
|
|
"api_call": "POST /users/{userId}/customerSecretKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service's Amazon S3\ncompatible API. The secret key consists of an Access Key/Secret Key pair. For information, see\n[Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the secret key (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateCustomerSecretKey](https://docs.oracle.com/iaas/api/#/en/identity/20160918/CustomerSecretKeySummary/UpdateCustomerSecretKey).\n\nEvery user has permission to create a secret key for *their own user ID*. An administrator in your organization\ndoes not need to write a policy to give users this ability. To compare, administrators who have permission to the\ntenancy can use this operation to create a secret key for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id} > actions: ActivateMfaTotpDevice",
|
|
"api_call": "POST /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id} > actions: GenerateTotpSeed",
|
|
"api_call": "POST /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/generateSeed",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Generate seed for the MFA TOTP device.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id}: DeleteMfaTotpDevice",
|
|
"api_call": "DELETE /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Deletes the specified MFA TOTP device for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id}: GetMfaTotpDevice",
|
|
"api_call": "GET /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Get the specified MFA TOTP device for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices: ListMfaTotpDevices",
|
|
"api_call": "GET /users/{userId}/mfaTotpDevices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the MFA TOTP devices for the specified user. The returned object contains the device's OCID, but not\nthe seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices: CreateMfaTotpDevice",
|
|
"api_call": "POST /users/{userId}/mfaTotpDevices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials > {oauth2Client Credential Id}: Delete Oauth token for the user",
|
|
"api_call": "DELETE /users/{userId}/oauth2ClientCredentials/{oauth2ClientCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"oauth2ClientCredentialId": "[REQUIRED] string: (Required) The ID of the Oauth credential."
|
|
},
|
|
"functionality": "Delete Oauth token for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials > {oauth2Client Credential Id}: Updates Oauth token for the user",
|
|
"api_call": "PUT /users/{userId}/oauth2ClientCredentials/{oauth2ClientCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"oauth2ClientCredentialId": "[REQUIRED] string: (Required) The ID of the Oauth credential."
|
|
},
|
|
"functionality": "Updates Oauth token for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials: List of Oauth tokens for the user",
|
|
"api_call": "GET /users/{userId}/oauth2ClientCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "List of Oauth tokens for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials: Creates Oauth token for the user",
|
|
"api_call": "POST /users/{userId}/oauth2ClientCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates Oauth token for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials > {smtp Credential Id}: DeleteSmtpCredential",
|
|
"api_call": "DELETE /users/{userId}/smtpCredentials/{smtpCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"smtpCredentialId": "[REQUIRED] string: (Required) The OCID of the SMTP credential."
|
|
},
|
|
"functionality": "Deletes the specified SMTP credential for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials > {smtp Credential Id}: UpdateSmtpCredential",
|
|
"api_call": "PUT /users/{userId}/smtpCredentials/{smtpCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"smtpCredentialId": "[REQUIRED] string: (Required) The OCID of the SMTP credential."
|
|
},
|
|
"functionality": "Updates the specified SMTP credential's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials: ListSmtpCredentials",
|
|
"api_call": "GET /users/{userId}/smtpCredentials/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID,\nthe SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials: CreateSmtpCredential",
|
|
"api_call": "POST /users/{userId}/smtpCredentials/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new SMTP credential for the specified user. An SMTP credential has an SMTP user name and an SMTP password.\nYou must specify a *description* for the SMTP credential (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateSmtpCredential](https://docs.oracle.com/iaas/api/#/en/identity/20160918/SmtpCredentialSummary/UpdateSmtpCredential).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords > {swift Password Id}: DeleteSwiftPassword",
|
|
"api_call": "DELETE /users/{userId}/swiftPasswords/{swiftPasswordId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"swiftPasswordId": "[REQUIRED] string: (Required) The OCID of the Swift password."
|
|
},
|
|
"functionality": "**Deprecated. Use [DeleteAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/DeleteAuthToken) instead.**\n\nDeletes the specified Swift password for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords > {swift Password Id}: UpdateSwiftPassword",
|
|
"api_call": "PUT /users/{userId}/swiftPasswords/{swiftPasswordId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"swiftPasswordId": "[REQUIRED] string: (Required) The OCID of the Swift password."
|
|
},
|
|
"functionality": "**Deprecated. Use [UpdateAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/UpdateAuthToken) instead.**\n\nUpdates the specified Swift password's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords: ListSwiftPasswords",
|
|
"api_call": "GET /users/{userId}/swiftPasswords/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "**Deprecated. Use [ListAuthTokens](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/ListAuthTokens) instead.**\n\nLists the Swift passwords for the specified user. The returned object contains the password's OCID, but not\nthe password itself. The actual password is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords: CreateSwiftPassword",
|
|
"api_call": "POST /users/{userId}/swiftPasswords/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "**Deprecated. Use [CreateAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/CreateAuthToken) instead.**\n\nCreates a new Swift password for the specified user. For information about what Swift passwords are for, see\n[Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the Swift password (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateSwiftPassword](https://docs.oracle.com/iaas/api/#/en/identity/20160918/SwiftPassword/UpdateSwiftPassword).\n\nEvery user has permission to create a Swift password for *their own user ID*. An administrator in your organization\ndoes not need to write a policy to give users this ability. To compare, administrators who have permission to the\ntenancy can use this operation to create a Swift password for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: DeleteUser",
|
|
"api_call": "DELETE /users/{userId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Deletes the specified user. The user must not be in any groups.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: GetUser",
|
|
"api_call": "GET /users/{userId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Gets the specified user's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: UpdateUser",
|
|
"api_call": "PUT /users/{userId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Updates the description of the specified user.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: UpdateUserCapabilities",
|
|
"api_call": "PUT /users/{userId}/capabilities/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Updates the capabilities of the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: UpdateUserState",
|
|
"api_call": "PUT /users/{userId}/state/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Updates the state of the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: CreateOrResetUIPassword",
|
|
"api_call": "POST /users/{userId}/uiPassword",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new Console one-time password for the specified user. For more information about user\ncredentials, see [User Credentials](https://docs.oracle.com/iaas/Content/Identity/Concepts/usercredentials.htm).\n\nUse this operation after creating a new user, or if a user forgets their password. The new one-time\npassword is returned to you in the response, and you must securely deliver it to the user. They'll\nbe prompted to change this password the next time they sign in to the Console. If they don't change\nit within 7 days, the password will expire and you'll need to create a new one-time password for the\nuser.\n\n**Note:** The user's Console login is the unique name you specified when you created the user\n(see [CreateUser](https://docs.oracle.com/iaas/api/#/en/identity/20160918/User/CreateUser)).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users: ListUsers",
|
|
"api_call": "GET /users/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the users in your tenancy. You must specify your tenancy's OCID as the value for the\ncompartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users: CreateUser",
|
|
"api_call": "POST /users/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other\nIAM Service components, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the\ntenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and\nsome policies) reside within the tenancy itself, unlike cloud resources such as compute instances,\nwhich typically reside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the user, which must be unique across all users in your tenancy\nand cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods,\nunderscores, +, and @. If you specify a name that's already in use, you'll get a 409 error.\nThis name will be the user's login to the Console. You might want to pick a\nname that your company's own identity system (e.g., Active Directory, LDAP, etc.) already uses.\nIf you delete a user and then create a new user with the same name, they'll be considered different\nusers because they have different OCIDs.\n\nYou must also specify a *description* for the user (although it can be an empty string).\nIt does not have to be unique, and you can change it anytime with\n[UpdateUser](https://docs.oracle.com/iaas/api/#/en/identity/20160918/User/UpdateUser). You can use the field to provide the user's\nfull name, a description, a nickname, or other information to generally identify the user.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before\nusing the object, first make sure its `lifecycleState` has changed to ACTIVE.\n\nA new user has no permissions until you place the user in one or more groups (see\n[AddUserToGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UserGroupMembership/AddUserToGroup)). If the user needs to\naccess the Console, you need to provide the user a password (see\n[CreateOrResetUIPassword](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UIPassword/CreateOrResetUIPassword)).\nIf the user needs to access the Oracle Cloud Infrastructure REST API, you need to upload a\npublic API signing key for that user (see\n[Required Keys and OCIDs](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm) and also\n[UploadApiKey](https://docs.oracle.com/iaas/api/#/en/identity/20160918/ApiKey/UploadApiKey)).\n\n**Important:** Make sure to inform the new user which compartment(s) they have access to.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - work Requests: ListWorkRequests",
|
|
"api_call": "GET /workRequests/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the work requests in compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - work Requests: GetWorkRequest",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header\nfor any asynchronous operation in the Identity and Access Management service.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - General: ListAvailabilityDomains",
|
|
"api_call": "GET /availabilityDomains/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n"
|
|
},
|
|
"functionality": "Lists the availability domains in your tenancy. Specify the OCID of either the tenancy or another\nof your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\nNote that the order of the results returned can change if availability domains are added or removed; therefore, do not\ncreate a dependency on the list order.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - General: ListFaultDomains",
|
|
"api_call": "GET /faultDomains/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"availabilityDomain": "string: (Required) The name of the availibilityDomain.\n"
|
|
},
|
|
"functionality": "Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another\nof your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - General: ListRegions",
|
|
"api_call": "GET /regions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header"
|
|
},
|
|
"functionality": "Lists all the regions offered by Oracle Cloud Infrastructure.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect dominant language over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectDominantLanguage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API returns the detected language and a related confidence score (between 0 and 1). It supports passing a batch of records.\n\n[List of supported languages.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch Detect entities over pre-deployed model",
|
|
"api_call": "POST /actions/batchDetectLanguageEntities",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts entities in text records. For each entity, its type/subtype and confidence score (between 0 and 1) is returned. It supports passing a batch of records.\n\n[List of supported entities.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#ner__sup-ner-entity)\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect keyPhrase over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectLanguageKeyPhrases",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text. It supports passing a batch of records.\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect sentiments over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectLanguageSentiments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"level": "string: Set this parameter for sentence and aspect level sentiment analysis.\nAllowed values are:\n - ASPECT\n - SENTENCE\n"
|
|
},
|
|
"functionality": "The API extracts aspect-based and sentence level sentiment in text records.\n\nFor aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned for each record. Similarly, for sentence-level sentiment analysis, the sentiment is returned at the sentence level.\n\nFor sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral and mixed).\n\nLearn more about sentiment analysis [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment).\n\nLimitations:\n - A batch may have up to 100 records.\n - A record may be up to 5000 characters long.\n - The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect text classification over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectLanguageTextClassification",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.\n\nIt supports passing a batch of records.\n\nLearn more about text classification [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class).\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect dominant language over pre-deployed model.",
|
|
"api_call": "POST /actions/detectDominantLanguage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API returns the detected language and a related confidence score (between 0 and 1).\n\n[List of supported languages.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)\n\nLimitations:\n- A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect entities over pre-deployed model",
|
|
"api_call": "POST /actions/detectLanguageEntities",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelVersion": "number: Named Entity Recognition model versions. By default user will get output from V2.1 implementation.",
|
|
"isPii": "boolean: If this parameter is set to true, you only get PII (Personally identifiable information) entities\nlike PhoneNumber, Email, Person, and so on. Default value is false.\n"
|
|
},
|
|
"functionality": "The API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned.\n\nLimitations:\n- A text may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect keyPhrase over pre-deployed model.",
|
|
"api_call": "POST /actions/detectLanguageKeyPhrases",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text.\n\nLimitations:\n- A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect sentiments over pre-deployed model.",
|
|
"api_call": "POST /actions/detectLanguageSentiments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts aspect-based in text records.\n\nFor aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned.\n\nFor sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral).\n\nLearn more about sentiment analysis [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment).\n\nLimitations:\n - A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect text classification over pre-deployed model.",
|
|
"api_call": "POST /actions/detectLanguageTextClassification",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.\n\nLearn more about text classification [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class).\n\nLimitations:\n- A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Logging Search API - General: Search logs.",
|
|
"api_call": "POST /search",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return in a response.\n"
|
|
},
|
|
"functionality": "Submit a query to search logs.\n\nSee [Using the API](https://docs.oracle.com/iaas/Content/Logging/Concepts/using_the_api_searchlogs.htm) for SDK examples.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements > {acceptedAgreementId}: Removes an accepted terms of use agreement.",
|
|
"api_call": "DELETE /acceptedAgreements/{acceptedAgreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"signature": "string: Previously, the signature generated for the listing package terms of use agreement, but now deprecated and ignored.",
|
|
"acceptedAgreementId": "[REQUIRED] string: (Required) The unique identifier for the accepted terms of use agreement."
|
|
},
|
|
"functionality": "Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks\nbefore initiating a deployment. Listings in Marketplace that require acceptance of the specified terms\nof use can no longer be deployed, but existing deployments aren't affected.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements > {acceptedAgreementId}: Gets the details of a terms of use agreement.",
|
|
"api_call": "GET /acceptedAgreements/{acceptedAgreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"acceptedAgreementId": "[REQUIRED] string: (Required) The unique identifier for the accepted terms of use agreement."
|
|
},
|
|
"functionality": "Gets the details of a specific, previously accepted terms of use agreement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements > {acceptedAgreementId}: Updates an accepted terms of use agreement.",
|
|
"api_call": "PUT /acceptedAgreements/{acceptedAgreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"acceptedAgreementId": "[REQUIRED] string: (Required) The unique identifier for the accepted terms of use agreement."
|
|
},
|
|
"functionality": "Updates the display name or tags associated with a listing's previously accepted terms of use agreement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements: Gets the list of accepted terms of use agreements in the specified compartment.",
|
|
"api_call": "GET /acceptedAgreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"displayName": "string: The display name of the resource.",
|
|
"listingId": "string: The unique identifier for the listing.",
|
|
"packageVersion": "string: The version of the package. Package versions are unique within a listing.",
|
|
"acceptedAgreementId": "string: The unique identifier for the accepted terms of use agreement.",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMEACCEPTED` displays results in descending order by default. You can change your\npreference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call."
|
|
},
|
|
"functionality": "Lists the terms of use agreements that have been accepted in the specified compartment.\nYou can filter results by specifying query parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements: Accepts a terms of use agreement for a listing.",
|
|
"api_call": "POST /acceptedAgreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Accepts a terms of use agreement for a specific package version of a listing. You must accept all\nterms of use for a package before you can deploy the package.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages > {packageVersion} > agreements: Lists terms of use agreements for a package.",
|
|
"api_call": "GET /listings/{listingId}/packages/{packageVersion}/agreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing."
|
|
},
|
|
"functionality": "Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages > {packageVersion} > agreements: Gets a terms of use agreement for a package.",
|
|
"api_call": "GET /listings/{listingId}/packages/{packageVersion}/agreements/{agreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing.",
|
|
"agreementId": "[REQUIRED] string: (Required) The unique identifier for the agreement."
|
|
},
|
|
"functionality": "Returns a terms of use agreement for a package with a time-based signature that can be used to\naccept the agreement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages > {packageVersion}: Get the details of a specific package version.",
|
|
"api_call": "GET /listings/{listingId}/packages/{packageVersion}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing."
|
|
},
|
|
"functionality": "Get the details of the specified version of a package, including information needed to launch the package.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages: Gets the list of packages for a listing.",
|
|
"api_call": "GET /listings/{listingId}/packages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"packageVersion": "string: The version of the package. Package versions are unique within a listing.",
|
|
"packageType": "string: A filter to return only packages that match the given package type exactly.\n",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing."
|
|
},
|
|
"functionality": "Gets the list of packages for a listing.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId}: Gets the details of a listing.",
|
|
"api_call": "GET /listings/{listingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing."
|
|
},
|
|
"functionality": "Gets detailed information about a listing, including the listing's name, version, description, and\nresources.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId}: Gets tax implication that current tenant may be eligible while using specific listing.",
|
|
"api_call": "GET /listings/{listingId}/taxes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing."
|
|
},
|
|
"functionality": "Returns list of all tax implications that current tenant may be liable to once they launch the listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings: Gets a list of listings.",
|
|
"api_call": "GET /listings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"pricing": "string: Name of the pricing type. If multiple pricing types are provided, then any listing with\none or more matching pricing models will be returned.\n",
|
|
"listingTypes": "string: The type of the listing.",
|
|
"compartmentId": "string: The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and\nfiltering according to listing attributes.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId} > packages: Lists the packages in a publication.",
|
|
"api_call": "GET /publications/{publicationId}/packages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"packageVersion": "string: The version of the package. Package versions are unique within a listing.",
|
|
"packageType": "string: A filter to return only packages that match the given package type exactly.\n",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Lists the packages in the specified publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId} > packages: Gets a package version of a specified publication.",
|
|
"api_call": "GET /publications/{publicationId}/packages/{packageVersion}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing."
|
|
},
|
|
"functionality": "Gets the details of a specific package version within a given publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Deletes a publication.",
|
|
"api_call": "DELETE /publications/{publicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Deletes a publication, which also removes the associated listing from anywhere it was published, such as Marketplace or Compute.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Gets a publication.",
|
|
"api_call": "GET /publications/{publicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Gets the details of the specified publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Updates an existing publication.",
|
|
"api_call": "PUT /publications/{publicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Updates the details of an existing publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Changes the compartment of the publication.",
|
|
"api_call": "POST /publications/{publicationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Moves the specified publication from one compartment to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications: Lists all publications.",
|
|
"api_call": "GET /publications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"listingType": "string: (Required) The type of the listing.",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n"
|
|
},
|
|
"functionality": "Lists the publications in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications: Creates a publication.",
|
|
"api_call": "POST /publications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a publication of the specified listing type with an optional default package.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Gets a list of listing categories.",
|
|
"api_call": "GET /categories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"compartmentId": "string: The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace. Categories apply\nto the software product provided by the listing.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Get Tenant eligibility and other information for launching a PIC image",
|
|
"api_call": "GET /launchEligibility",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"imageId": "string: (Required) Image ID"
|
|
},
|
|
"functionality": "Returns Tenant eligibility and other information for launching a PIC image",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Gets a list of publishers.",
|
|
"api_call": "GET /publishers",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"compartmentId": "string: The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Lists available reports.",
|
|
"api_call": "GET /reportTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call."
|
|
},
|
|
"functionality": "Lists available types of reports for the compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Lists reports.",
|
|
"api_call": "GET /reports",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"reportType": "string: (Required) The type of the report.",
|
|
"date": "number: (Required) Date, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The service only interprets the year, month, and day parts in the input value, and ignores the hour, minute, and second parts.\n",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Lists reports in the compartment that match the specified report type and date.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Finds Marketplace listings",
|
|
"api_call": "POST /searchListings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n"
|
|
},
|
|
"functionality": "Queries all Marketplace Applications to find listings that match the specified criteria. To search \nfor a listing, you can use a free text or structured search.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Get eligibilty of the tenancy to see third party paid listings",
|
|
"api_call": "GET /thirdPartyPaidListingEligibility",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Returns eligibility details of the tenancy to see and launch third party paid listings",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id} > distribution Channel Attachments > {distribution Channel Id}: Deletes a MediaAsset from DistributionChannel.",
|
|
"api_call": "DELETE /mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"version": "integer: Version of the attachment.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier",
|
|
"distributionChannelId": "[REQUIRED] string: (Required) Unique DistributionChannel identifier."
|
|
},
|
|
"functionality": "Deletes a MediaAsset from the DistributionChannel by identifiers.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id} > distribution Channel Attachments > {distribution Channel Id}: Get a MediaAssetDistributionChannelAttachment for a MediaAsset.",
|
|
"api_call": "GET /mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"version": "integer: Version of the attachment.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier",
|
|
"distributionChannelId": "[REQUIRED] string: (Required) Unique DistributionChannel identifier."
|
|
},
|
|
"functionality": "Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id} > distribution Channel Attachments: List MediaAssetDistributionChannelAttachments for MediaAsset.",
|
|
"api_call": "GET /mediaAssets/{mediaAssetId}/distributionChannelAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"displayName": "string: A filter to return only the resources that match the entire display name given.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Delete a provisioned MediaAsset",
|
|
"api_call": "DELETE /mediaAssets/{mediaAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"deleteMode": "string: DeleteMode decides whether to delete all the immediate children or all assets with the asset's ID as their masterMediaAssetId.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Deletes a MediaAsset resource by identifier. If DeleteChildren is passed in as the mode, all the assets with the parentMediaAssetId matching the ID will be deleted. If DeleteDerivatives is set as the mode, all the assets with the masterMediaAssetId matching the ID will be deleted.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Get MediaAsset",
|
|
"api_call": "GET /mediaAssets/{mediaAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Gets a MediaAsset by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Update the MediaAsset identified by the ID.",
|
|
"api_call": "PUT /mediaAssets/{mediaAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Updates the MediaAsset.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Moves an asset into a different compartment.",
|
|
"api_call": "POST /mediaAssets/{mediaAssetId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Moves a MediaAsset resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets: Gets a list of all MediaAssetSummary in a compartment.",
|
|
"api_call": "GET /mediaAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Returns a list of MediaAssetSummary.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets: Creates a new MediaAsset",
|
|
"api_call": "POST /mediaAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new MediaAsset.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Deletes a provisioned MediaWorkflowConfiguration.",
|
|
"api_call": "DELETE /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Deletes a MediaWorkflowConfiguration resource by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Get MediaWorkflowConfiguration",
|
|
"api_call": "GET /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Gets a MediaWorkflowConfiguration by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Update the MediaWorkflowConfiguration identified by the ID.",
|
|
"api_call": "PUT /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Updates the MediaWorkflowConfiguration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Moves a MediaWorkflowConfiguration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations: Gets a list of all MediaWorkflowConfigurations in a compartment.",
|
|
"api_call": "GET /mediaWorkflowConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Returns a list of MediaWorkflowConfigurations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations: Creates a new MediaWorkflowConfiguration.",
|
|
"api_call": "POST /mediaWorkflowConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new MediaWorkflowConfiguration.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id} > facts: List MediaWorkflowJobFacts",
|
|
"api_call": "GET /mediaWorkflowJobs/{mediaWorkflowJobId}/facts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Internal API to get a point-in-time snapshot of a MediaWorkflowJob.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id} > facts: Get a MediaWorkflowJobFact",
|
|
"api_call": "GET /mediaWorkflowJobs/{mediaWorkflowJobId}/facts/{key}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier.",
|
|
"key": "[REQUIRED] integer: (Required) Identifier of the MediaWorkflowJobFact within a MediaWorkflowJob."
|
|
},
|
|
"functionality": "Get the MediaWorkflowJobFact identified by the mediaWorkflowJobId and Fact ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Cancel a MediaWorkflowJob identified by the mediaWorkflowJobId",
|
|
"api_call": "DELETE /mediaWorkflowJobs/{mediaWorkflowJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "This is an asynchronous operation. The MediaWorkflowJob lifecycleState will change to CANCELING temporarily until the job is completely CANCELED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Get MediaWorkflowJob identified by the mediaWorkflowId and jobId",
|
|
"api_call": "GET /mediaWorkflowJobs/{mediaWorkflowJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Gets the MediaWorkflowJob.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Update the MediaWorkflowJob identified by the id",
|
|
"api_call": "PUT /mediaWorkflowJobs/{mediaWorkflowJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Updates the MediaWorkflowJob.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /mediaWorkflowJobs/{mediaWorkflowJobId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Moves a MediaWorkflowJob resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs: List MediaWorkflowJobs in a compartment",
|
|
"api_call": "GET /mediaWorkflowJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"sortBy": "string: The parameter sort by.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'."
|
|
},
|
|
"functionality": "Lists the MediaWorkflowJobs.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs: Creates and runs a MediaWorkflowJob for the the MediaWorkflow identified by mediaWorkflowId",
|
|
"api_call": "POST /mediaWorkflowJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Run the MediaWorkflow according to the given mediaWorkflow definition and configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Deletes a MediaWorkflow identified by the mediaWorkflowId.",
|
|
"api_call": "DELETE /mediaWorkflows/{mediaWorkflowId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "The MediaWorkflow lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Gets MediaWorkflow.",
|
|
"api_call": "GET /mediaWorkflows/{mediaWorkflowId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "Gets a MediaWorkflow by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Updates the MediaWorkflow identified by the ID.",
|
|
"api_call": "PUT /mediaWorkflows/{mediaWorkflowId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "Updates the MediaWorkflow.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /mediaWorkflows/{mediaWorkflowId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "Moves a MediaWorkflow resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows: Lists the MediaWorkflows.",
|
|
"api_call": "GET /mediaWorkflows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the MediaWorkflows.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows: Creates a new MediaWorkflow.",
|
|
"api_call": "POST /mediaWorkflows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new MediaWorkflow.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs > {stream Cdn Config Id}: Deletes a StreamCdnConfig identified by the streamCdnConfigId.",
|
|
"api_call": "DELETE /streamCdnConfigs/{streamCdnConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"streamCdnConfigId": "[REQUIRED] string: (Required) Unique StreamCdnConfig identifier."
|
|
},
|
|
"functionality": "The StreamCdnConfig lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs > {stream Cdn Config Id}: Gets StreamCdnConfig.",
|
|
"api_call": "GET /streamCdnConfigs/{streamCdnConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"streamCdnConfigId": "[REQUIRED] string: (Required) Unique StreamCdnConfig identifier."
|
|
},
|
|
"functionality": "Gets a StreamCdnConfig by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs > {stream Cdn Config Id}: Updates the StreamCdnConfig identified by the ID.",
|
|
"api_call": "PUT /streamCdnConfigs/{streamCdnConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamCdnConfigId": "[REQUIRED] string: (Required) Unique StreamCdnConfig identifier."
|
|
},
|
|
"functionality": "Updates the StreamCdnConfig.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs: Lists the StreamCdnConfig.",
|
|
"api_call": "GET /streamCdnConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"distributionChannelId": "string: (Required) The Stream Distribution Channel identifier this CdnConfig belongs to.\n"
|
|
},
|
|
"functionality": "Lists the StreamCdnConfig.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs: Creates a new CDN Configuration.",
|
|
"api_call": "POST /streamCdnConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new CDN Configuration.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id} > actions: Moves a resource into a different compartment.",
|
|
"api_call": "POST /streamDistributionChannels/{streamDistributionChannelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Moves a Stream Distribution Channel resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id} > actions: Ingests an Asset into a Distribution Channel.",
|
|
"api_call": "POST /streamDistributionChannels/{streamDistributionChannelId}/actions/ingest",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Ingests an Asset into a Distribution Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id}: Deletes a Stream Distribution Channel identified by the streamDistributionChannelId.",
|
|
"api_call": "DELETE /streamDistributionChannels/{streamDistributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "The Stream Distribution Channel lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id}: Gets a Stream Distribution Channel.",
|
|
"api_call": "GET /streamDistributionChannels/{streamDistributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Gets a Stream Distribution Channel by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id}: Update the Stream Distribution Channel identified by the id",
|
|
"api_call": "PUT /streamDistributionChannels/{streamDistributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Updates the Stream Distribution Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels: Lists Stream Distribution Channels.",
|
|
"api_call": "GET /streamDistributionChannels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the Stream Distribution Channels.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels: Creates a new Stream Distribution Channel",
|
|
"api_call": "POST /streamDistributionChannels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new Stream Distribution Channel.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs > {stream Packaging Config Id}: Deletes a Stream Packaging Configuration identified by the streamPackagingConfigId.",
|
|
"api_call": "DELETE /streamPackagingConfigs/{streamPackagingConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"streamPackagingConfigId": "[REQUIRED] string: (Required) Unique Stream Packaging Configuration path identifier."
|
|
},
|
|
"functionality": "The Stream Packaging Configuration lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs > {stream Packaging Config Id}: Get a Stream Packaging Configuration.",
|
|
"api_call": "GET /streamPackagingConfigs/{streamPackagingConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"streamPackagingConfigId": "[REQUIRED] string: (Required) Unique Stream Packaging Configuration path identifier."
|
|
},
|
|
"functionality": "Gets a Stream Packaging Configuration by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs > {stream Packaging Config Id}: Updates the Stream Packaging Configuration identified by the ID.",
|
|
"api_call": "PUT /streamPackagingConfigs/{streamPackagingConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamPackagingConfigId": "[REQUIRED] string: (Required) Unique Stream Packaging Configuration path identifier."
|
|
},
|
|
"functionality": "Updates the Stream Packaging Configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs: List Stream Packaging Configurations",
|
|
"api_call": "GET /streamPackagingConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"distributionChannelId": "string: (Required) Unique Stream Distribution Channel identifier."
|
|
},
|
|
"functionality": "Lists the Stream Packaging Configurations.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs: Creates a new Stream Packaging Configuration.",
|
|
"api_call": "POST /streamPackagingConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new Packaging Configuration.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - General: Gets a list of all MediaWorkflowTaskDeclarations.",
|
|
"api_call": "GET /mediaWorkflowTaskDeclarations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'."
|
|
},
|
|
"functionality": "Returns a list of MediaWorkflowTaskDeclarations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - General: Lists SystemMediaWorkflows.",
|
|
"api_call": "GET /systemMediaWorkflows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id} > actions: Change Alarm Compartment",
|
|
"api_call": "POST /alarms/{alarmId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Moves an alarm into a different compartment within the same tenancy.\n\nFor information about moving resources between compartments, see [Moving Resources Between Compartments](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id} > actions: Removes any existing suppression for the specified alarm.\n",
|
|
"api_call": "POST /alarms/{alarmId}/actions/removeSuppression",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Removes any existing suppression for the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Get Alarm",
|
|
"api_call": "GET /alarms/{alarmId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Gets the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Updates an alarm.\n",
|
|
"api_call": "PUT /alarms/{alarmId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Updates the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Deletes an alarm.\n",
|
|
"api_call": "DELETE /alarms/{alarmId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Deletes the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Get Alarm History",
|
|
"api_call": "GET /alarms/{alarmId}/history",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"alarmHistorytype": "string: The type of history entries to retrieve. State history (STATE_HISTORY) or state transition history (STATE_TRANSITION_HISTORY).\nIf not specified, entries of both types are retrieved.\n\nExample: `STATE_HISTORY`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"timestampGreaterThanOrEqualTo": "number: A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.\n\nExample: `2019-01-01T01:00:00.789Z`\n",
|
|
"timestampLessThan": "number: A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.\n\nExample: `2019-01-02T01:00:00.789Z`\n",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Get the history of the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms: List Alarms",
|
|
"api_call": "GET /alarms",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.\n",
|
|
"lifecycleState": "string: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.\n",
|
|
"sortBy": "string: The field to use when sorting returned alarm definitions. Only one sorting level is provided.\n\nExample: `severity`\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
|
|
},
|
|
"functionality": "Lists the alarms for the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms: Creates a new alarm in the specified compartment.\n",
|
|
"api_call": "POST /alarms",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new alarm in the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms: List Alarms Status",
|
|
"api_call": "GET /alarms/status",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"sortBy": "string: The field to use when sorting returned alarm definitions. Only one sorting level is provided.\n\nExample: `severity`\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\n"
|
|
},
|
|
"functionality": "List the status of each alarm in the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - metrics > actions: List metrics based on matching criteria.",
|
|
"api_call": "POST /metrics/actions/listMetrics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
|
|
},
|
|
"functionality": "Returns metric definitions that match the criteria specified in the request. Compartment OCID required.\nFor information about metrics, see [Metrics Overview](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nTransactions Per Second (TPS) per-tenancy limit for this operation: 10.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - metrics > actions: Summarizes and returns metrics data filtered using the provided query expression and compartmentId.",
|
|
"api_call": "POST /metrics/actions/summarizeMetricsData",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
|
|
},
|
|
"functionality": "Returns aggregated data that match the criteria specified in the request. Compartment OCID required.\nFor information on metric queries, see [Building Metric Queries](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/buildingqueries.htm).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nTransactions Per Second (TPS) per-tenancy limit for this operation: 10.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - metrics: Publishes raw metric data points to the Monitoring service.\n",
|
|
"api_call": "POST /metrics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Publishes raw metric data points to the Monitoring service.\nFor more information about publishing metrics, see [Publishing Custom Metrics](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nPer-call limits information follows.\n\n* Dimensions per metric group*. Maximum: 20. Minimum: 1.\n* Unique metric streams*. Maximum: 50.\n* Transactions Per Second (TPS) per-tenancy limit for this operation: 50.\n\n*A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits.\nA dimension is a qualifier provided in a metric definition.\nA metric stream is an individual set of aggregated data for a metric, typically specific to a resource.\nFor more information about metric-related concepts, see [Monitoring Concepts](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).\n\nThe endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example:\n\nhttps://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - query: Execute a SQL query.",
|
|
"api_call": "POST /query",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Execute a SQL query.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - query: Prepare a SQL statement for use in a query with variable substitution.\n",
|
|
"api_call": "GET /query/prepare",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"statement": "string: (Required) A NoSQL SQL statement."
|
|
},
|
|
"functionality": "Prepare a SQL statement for use in a query with variable substitution.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - query: Check the syntax and return a brief summary of a SQL statement.",
|
|
"api_call": "GET /query/summarize",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"statement": "string: (Required) A NoSQL SQL statement."
|
|
},
|
|
"functionality": "Check the syntax and return a brief summary of a SQL statement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes > {indexName}: Delete an index.",
|
|
"api_call": "DELETE /tables/{tableNameOrId}/indexes/{indexName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"isIfExists": "boolean: Set as true to select \"if exists\" behavior.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID.",
|
|
"indexName": "[REQUIRED] string: (Required) The name of a table's index."
|
|
},
|
|
"functionality": "Delete an index from the table identified by tableNameOrId.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes > {indexName}: Get information about a single index.",
|
|
"api_call": "GET /tables/{tableNameOrId}/indexes/{indexName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID.",
|
|
"indexName": "[REQUIRED] string: (Required) The name of a table's index."
|
|
},
|
|
"functionality": "Get information about a single index.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes: Get a list of indexes on a table.",
|
|
"api_call": "GET /tables/{tableNameOrId}/indexes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"name": "string: A shell-globbing-style (*?[]) filter for names.",
|
|
"lifecycleState": "string: Filter list by the lifecycle state of the item.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be\nprovided. Default order for timeCreated is descending. Default\norder for name is ascending. If no value is specified\ntimeCreated is default.\n",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get a list of indexes on a table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes: Create a new index.",
|
|
"api_call": "POST /tables/{tableNameOrId}/indexes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried\nin case of a timeout or server error without risk of executing\nthat same action again. Retry tokens expire after 24 hours, but\ncan be invalidated before then due to conflicting\noperations. For example, if a resource has been deleted and\npurged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Create a new index on the table identified by tableNameOrId.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > rows: Delete a single row from the table, by primary key.",
|
|
"api_call": "DELETE /tables/{tableNameOrId}/rows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"key": "string: (Required) An array of strings, each of the format \"column-name:value\",\nrepresenting the primary key of the row.\n",
|
|
"isGetReturnRow": "boolean: If true, and the operation fails due to an option setting\n(ifVersion et al), then the existing row will be returned.\n",
|
|
"timeoutInMs": "integer: Timeout setting for this operation.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Delete a single row from the table, by primary key.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > rows: Get a single row from the table by primary key.",
|
|
"api_call": "GET /tables/{tableNameOrId}/rows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"key": "string: (Required) An array of strings, each of the format \"column-name:value\",\nrepresenting the primary key of the row.\n",
|
|
"consistency": "string: Consistency requirement for a read operation.",
|
|
"timeoutInMs": "integer: Timeout setting for this operation.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get a single row from the table by primary key.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > rows: Write a single row into the table.",
|
|
"api_call": "PUT /tables/{tableNameOrId}/rows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Write a single row into the table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Delete a table by tableNameOrId.",
|
|
"api_call": "DELETE /tables/{tableNameOrId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"isIfExists": "boolean: Set as true to select \"if exists\" behavior.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Delete a table by tableNameOrId.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Get table info by identifier.",
|
|
"api_call": "GET /tables/{tableNameOrId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get table info by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Alter the table identified by tableNameOrId.",
|
|
"api_call": "PUT /tables/{tableNameOrId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Alter the table identified by tableNameOrId,\nchanging schema, limits, or tags\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Change a table's compartment.",
|
|
"api_call": "POST /tables/{tableNameOrId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried\nin case of a timeout or server error without risk of executing\nthat same action again. Retry tokens expire after 24 hours, but\ncan be invalidated before then due to conflicting\noperations. For example, if a resource has been deleted and\npurged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Change a table's compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Get table usage info.",
|
|
"api_call": "GET /tables/{tableNameOrId}/usage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"timeStart": "number: The start time to use for the request. If no time range\nis set for this request, the most recent complete usage\nrecord is returned.\n",
|
|
"timeEnd": "number: The end time to use for the request.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get table usage info.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables: Get a list of tables in a compartment.",
|
|
"api_call": "GET /tables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"name": "string: A shell-globbing-style (*?[]) filter for names.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be\nprovided. Default order for timeCreated is descending. Default\norder for name is ascending. If no value is specified\ntimeCreated is default.\n",
|
|
"lifecycleState": "string: Filter list by the lifecycle state of the item."
|
|
},
|
|
"functionality": "Get a list of tables in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables: Create a new table.",
|
|
"api_call": "POST /tables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried\nin case of a timeout or server error without risk of executing\nthat same action again. Retry tokens expire after 24 hours, but\ncan be invalidated before then due to conflicting\noperations. For example, if a resource has been deleted and\npurged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a new table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: Cancel a work request operation with the given ID.",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancel a work request operation with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: Get the status of the work request with the given ID.",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Get the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: List work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests: List the work requests in a compartment.",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "List the work requests in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {id}: Get Confirm Subscription",
|
|
"api_call": "GET /subscriptions/{id}/confirmation",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"token": "string: (Required) The subscription confirmation token.",
|
|
"protocol": "string: (Required) The protocol used for the subscription.\n\nAllowed values:\n * `CUSTOM_HTTPS`\n * `EMAIL`\n * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)\n * `ORACLE_FUNCTIONS`\n * `PAGERDUTY`\n * `SLACK`\n * `SMS`\n\nFor information about subscription protocols, see\n[To create a subscription](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#concepts__subscriptionprotocols).\n",
|
|
"id": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to get the confirmation details for.\n"
|
|
},
|
|
"functionality": "Gets the confirmation details for the specified subscription.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {id}: Resend Subscription Confirmation",
|
|
"api_call": "POST /subscriptions/{id}/resendConfirmation",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"id": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to resend the confirmation for.\n"
|
|
},
|
|
"functionality": "Resends the confirmation details for the specified subscription.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {id}: Get Unsubscription",
|
|
"api_call": "GET /subscriptions/{id}/unsubscription",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"token": "string: (Required) The subscription confirmation token.",
|
|
"protocol": "string: (Required) The protocol used for the subscription.\n\nAllowed values:\n * `CUSTOM_HTTPS`\n * `EMAIL`\n * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)\n * `ORACLE_FUNCTIONS`\n * `PAGERDUTY`\n * `SLACK`\n * `SMS`\n\nFor information about subscription protocols, see\n[To create a subscription](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#concepts__subscriptionprotocols).\n",
|
|
"id": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to unsubscribe from.\n"
|
|
},
|
|
"functionality": "Unsubscribes the subscription from the topic.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Get Subscription",
|
|
"api_call": "GET /subscriptions/{subscriptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to retrieve.\n"
|
|
},
|
|
"functionality": "Gets the specified subscription's configuration information.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Update Subscription",
|
|
"api_call": "PUT /subscriptions/{subscriptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to update.\n"
|
|
},
|
|
"functionality": "Updates the specified subscription's configuration.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Delete Subscription",
|
|
"api_call": "DELETE /subscriptions/{subscriptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to delete.\n"
|
|
},
|
|
"functionality": "Deletes the specified subscription.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Change Subscription Compartment",
|
|
"api_call": "POST /subscriptions/{subscriptionId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to move.\n"
|
|
},
|
|
"functionality": "Moves a subscription into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions: List Subscriptions",
|
|
"api_call": "GET /subscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n",
|
|
"topicId": "string: Return all subscriptions that are subscribed to the given topic OCID. Either this query parameter or the compartmentId query parameter must be set.\n",
|
|
"page": "string: For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the subscriptions in the specified compartment or topic.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions: Create Subscription",
|
|
"api_call": "POST /subscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in \"Pending\" status until it has been confirmed.\nFor information about confirming subscriptions, see\n[To confirm a subscription](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub).\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Get Topic",
|
|
"api_call": "GET /topics/{topicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to retrieve.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 120.\n"
|
|
},
|
|
"functionality": "Gets the specified topic's configuration information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Update Topic",
|
|
"api_call": "PUT /topics/{topicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to update.\n"
|
|
},
|
|
"functionality": "Updates the specified topic's configuration.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Delete Topic",
|
|
"api_call": "DELETE /topics/{topicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to delete.\n"
|
|
},
|
|
"functionality": "Deletes the specified topic.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Change Topic Compartment",
|
|
"api_call": "POST /topics/{topicId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to move.\n"
|
|
},
|
|
"functionality": "Moves a topic into a different compartment within the same tenancy. For information about moving resources\nbetween compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Publish Message",
|
|
"api_call": "POST /topics/{topicId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"messageType": "string: **Deprecated.**\nThis attribute is deprecated, as is support for JSON.\nYou can send a JSON payload even when transmitting the payload as a raw string.\nConfigure your receiving system to read the raw payload as JSON format.\n\nType of message body in the request.\nFor `messageType` of JSON, a default key-value pair is required. Example: `{\"default\": \"Alarm breached\", \"Email\": \"Alarm breached: <url>\"}.`\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.\n"
|
|
},
|
|
"functionality": "Publishes a message to the specified topic.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nLimits information follows.\n\nMessage size limit per request: 64KB.\n\nMessage delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the `EMAIL` protocol.\nHTTP-based protocols use URL endpoints that begin with \"http:\" or \"https:\".\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)\n\nFor more information about publishing messages, see [Publishing Messages](https://docs.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm).\nFor steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics: List Topics",
|
|
"api_call": "GET /topics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n",
|
|
"page": "string: For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. Only one field can be selected for sorting.\n",
|
|
"sortOrder": "string: The sort order to use (ascending or descending).\n",
|
|
"lifecycleState": "string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists topics in the specified compartment.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 120.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics: Create Topic",
|
|
"api_call": "POST /topics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a topic in the specified compartment. For general information about topics, see\n[Managing Topics and Subscriptions](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm).\n\nFor the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside.\nFor information about access control and compartments, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).\n\nYou must specify a display name for the topic.\n\nAll Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an\nOracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also\nretrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the\nConsole. For more information, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions > reencrypt: Re-encrypt Bucket Data Encryption Key",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/reencrypt",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Re-encrypts the unique data encryption key that encrypts each object written to the bucket by using the most recent \nversion of the master encryption key assigned to the bucket. (All data encryption keys are encrypted by a master \nencryption key. Master encryption keys are assigned to buckets and managed by Oracle by default, but you can assign \na key that you created and control through the Oracle Cloud Infrastructure Key Management service.) The kmsKeyId property \nof the bucket determines which master encryption key is assigned to the bucket. If you assigned a different Key Management \nmaster encryption key to the bucket, you can call this API to re-encrypt all data encryption keys with the newly \nassigned key. Similarly, you might want to re-encrypt all data encryption keys if the assigned key has been rotated to \na new key version since objects were last added to the bucket. If you call this API and there is no kmsKeyId associated \nwith the bucket, the call will fail.\n\nCalling this API starts a work request task to re-encrypt the data encryption key of all objects in the bucket. Only \nobjects created before the time of the API call will be re-encrypted. The call can take a long time, depending on how many \nobjects are in the bucket and how big they are. This API returns a work request ID that you can use to retrieve the status \nof the work request task.\nAll the versions of objects will be re-encrypted whether versioning is enabled or suspended at the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions > reencrypt: Re-encrypt the data encryption keys associated with an object",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/reencrypt/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"versionId": "string: VersionId used to identify a particular version of the object",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Re-encrypts the data encryption keys that encrypt the object and its chunks. By default, when you create a bucket, the Object Storage\nservice manages the master encryption key used to encrypt each object's data encryption keys. The encryption mechanism that you specify for\nthe bucket applies to the objects it contains.\n\nYou can alternatively employ one of these encryption strategies for an object:\n\n- You can assign a key that you created and control through the Oracle Cloud Infrastructure Vault service.\n\n- You can encrypt an object using your own encryption key. The key you supply is known as a customer-provided encryption key (SSE-C).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Creates a copy object request.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/copyObject",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-source-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm to use to decrypt the source\nobject. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-source-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to decrypt\nthe source object. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-source-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key used to\ndecrypt the source object. This value is used to check the integrity of the encryption key. For\nmore information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a request to copy an object within a region or to another region.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Stops the replication policy associated with a destination bucket.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/makeBucketWritable",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Stops replication to the destination bucket and removes the replication policy. When the replication\npolicy was created, this destination bucket became read-only except for new and changed objects replicated\nautomatically from the source bucket. MakeBucketWritable removes the replication policy. This bucket is no\nlonger the target for replication and is now writable, allowing users to make changes to bucket contents.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Rename Object",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/renameObject",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Rename an object in the given Object Storage namespace.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Restore Objects",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/restoreObjects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Restores one or more objects specified by the objectName parameter.\nBy default objects will be restored for 24 hours. Duration can be configured using the hours parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Move the object into a different storage tier",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/updateObjectStorageTier",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Changes the storage tier of the object specified by the objectName parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > l: GET object lifecycle policy",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/l",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Gets the object lifecycle policy for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > l: Put object lifecycle policy.",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/l",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates or replaces the object lifecycle policy for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > l: Delete object lifecycle policy",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/l",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Deletes the object lifecycle policy for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: GET Object",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"range": "string: Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7233#section-2.1).\nNote that only a single range of bytes is supported.\n",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Gets the metadata and body of an object. \n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: PUT Object",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Expect": "string: A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent.\nIf no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body.\nThe only allowed value for this parameter is \"100-Continue\" (case-insensitive).\n",
|
|
"Content-Length": "integer: (Required) The content length of the body.",
|
|
"Content-MD5": "string: The optional base-64 header that defines the encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object\nStorage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the\nMD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error\nis returned with the message:\n\n\"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)\"\n",
|
|
"Content-Language": "string: The optional Content-Language header that defines the content language of the object to upload. Specifying\nvalues for this header has no effect on Object Storage behavior. Programs that read the object determine what\nto do based on the value provided. For example, you could use this header to identify and differentiate objects\nbased on a particular language.\n",
|
|
"Content-Encoding": "string: The optional Content-Encoding header that defines the content encodings that were applied to the object to\nupload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the\nobject determine what to do based on the value provided. For example, you could use this header to determine\nwhat decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of\nthe object.\n",
|
|
"Content-Disposition": "string: The optional Content-Disposition header that defines presentational information for the object to be\nreturned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object\nStorage behavior. Programs that read the object determine what to do based on the value provided.\nFor example, you could use this header to let users download objects with custom filenames in a browser.\n",
|
|
"Cache-Control": "string: The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and\nHeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs\nthat read the object determine what to do based on the value provided.\nFor example, you could use this header to identify objects that require caching restrictions.\n",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"storage-tier": "string: The storage tier that the object should be stored in. If not specified, the object will be stored in\nthe same storage tier as the bucket.\n",
|
|
"opc-meta-*": "string: Optional user-defined metadata key and value.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by\nPutObject is 50 GiB.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements. \n\nSee [Special Instructions for Object Storage PUT](https://docs.oracle.com/iaas/Content/API/Concepts/signingrequests.htm#ObjectStoragePut)\nfor request signature requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: DELETE Object",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Deletes an object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: HEAD Object",
|
|
"api_call": "HEAD /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Gets the user-defined metadata and entity tag (ETag) for an object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o: List Objects",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/o",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists the objects in a bucket. By default, ListObjects returns object names only. See the `fields`\nparameter for other fields that you can optionally include in ListObjects response.\n\nListObjects returns at most 1000 objects. To paginate through more objects, use the returned 'nextStartWith'\nvalue with the 'start' parameter. To filter which objects ListObjects returns, use the 'start' and 'end'\nparameters.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p > {par Id}: GET Preauthenticated Request",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/p/{parId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"parId": "[REQUIRED] string: (Required) The unique identifier for the pre-authenticated request. This can be used to manage operations against\nthe pre-authenticated request, such as GET or DELETE.\n"
|
|
},
|
|
"functionality": "Gets the pre-authenticated request for the bucket.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p > {par Id}: DELETE Preauthenticated Request",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/p/{parId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"parId": "[REQUIRED] string: (Required) The unique identifier for the pre-authenticated request. This can be used to manage operations against\nthe pre-authenticated request, such as GET or DELETE.\n"
|
|
},
|
|
"functionality": "Deletes the pre-authenticated request for the bucket.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p: List Preauthenticated Requests",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/p/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists pre-authenticated requests for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p: Create Preauthenticated Request",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/p/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a pre-authenticated request specific to the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies > {replication Id}: Get replication policy.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"replicationId": "[REQUIRED] string: (Required) The ID of the replication policy."
|
|
},
|
|
"functionality": "Get the replication policy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies > {replication Id}: Delete replication policy.",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"replicationId": "[REQUIRED] string: (Required) The ID of the replication policy."
|
|
},
|
|
"functionality": "Deletes the replication policy associated with the source bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies: List the replication policies associated with a bucket.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/replicationPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "List the replication policies associated with a bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies: Create replication policy.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/replicationPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a replication policy for the specified bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules > {retention Rule Id}: Get the specified retention rule.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"retentionRuleId": "[REQUIRED] string: (Required) The ID of the retention rule."
|
|
},
|
|
"functionality": "Get the specified retention rule.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules > {retention Rule Id}: Update the specified retention rule.",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"retentionRuleId": "[REQUIRED] string: (Required) The ID of the retention rule."
|
|
},
|
|
"functionality": "Updates the specified retention rule. Rule changes take effect typically within 30 seconds.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules > {retention Rule Id}: Delete the specified retention rule.",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"retentionRuleId": "[REQUIRED] string: (Required) The ID of the retention rule."
|
|
},
|
|
"functionality": "Deletes the specified rule. The deletion takes effect typically within 30 seconds.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules: List the retention rules for a bucket.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/retentionRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Accept": "string",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "List the retention rules for a bucket. The retention rules are sorted based on creation time,\nwith the most recently created retention rule returned first.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules: Create a new retention rule.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/retentionRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a new retention rule in the specified bucket. The new rule will take effect typically within 30 seconds.\nNote that a maximum of 100 rules are supported on a bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: List Multipart Upload Parts",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Lists the parts of an in-progress multipart upload.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: Upload Multipart Object Part",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"Expect": "string: A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent.\nIf no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body.\nThe only allowed value for this parameter is \"100-Continue\" (case-insensitive).\n",
|
|
"Content-Length": "integer: (Required) The content length of the body.",
|
|
"Content-MD5": "string: The optional base-64 header that defines the encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object\nStorage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the\nMD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error\nis returned with the message:\n\n\"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)\"\n",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"uploadPartNum": "integer: (Required) The part number that identifies the object part currently being uploaded.",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Uploads a single part of a multipart upload.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: Commit Multipart Upload",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: Abort Multipart Upload",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Aborts an in-progress multipart upload and deletes all parts that have been uploaded.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u: List Multipart Uploads",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/u",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u: Create Multipart Upload",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/u",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Starts a new multipart upload to a specific object in the given bucket in the given namespace.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: GET Bucket",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"fields": "string: Bucket summary includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated',\nand 'etag' fields. This parameter can also include 'approximateCount' (approximate number of objects), 'approximateSize'\n(total approximate size in bytes of all objects) and 'autoTiering' (state of auto tiering on the bucket).\nFor example 'approximateCount,approximateSize,autoTiering'.\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Gets the current representation of the given bucket in the given Object Storage namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: POST Bucket",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Performs a partial or full update of a bucket's user-defined metadata.\n\nUse UpdateBucket to move a bucket from one compartment to another within the same tenancy. Supply the compartmentID\nof the compartment that you want to move the bucket to. For more information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: DELETE Bucket",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Deletes a bucket if the bucket is already empty. If the bucket is not empty, use\n[DeleteObject](#/en/objectstorage/20160918/methods/DeleteObject) first. In addition,\nyou cannot delete a bucket that has a multipart upload in progress or a pre-authenticated\nrequest associated with that bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: HEAD Bucket",
|
|
"api_call": "HEAD /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: List Object Versions",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/objectversions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists the object versions in a bucket.\n\nListObjectVersions returns an ObjectVersionCollection containing at most 1000 object versions. To paginate through\nmore object versions, use the returned `opc-next-page` value with the `page` request parameter.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: List the replication sources of a destination bucket.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/replicationSources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "List the replication sources of a destination bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b: List Buckets",
|
|
"api_call": "GET /n/{namespaceName}/b/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list buckets.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "Gets a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket\nand does not contain fields like the user-defined metadata.\n\nListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned\n`opc-next-page` value with the `page` request parameter.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b: Create Bucket",
|
|
"api_call": "POST /n/{namespaceName}/b/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering\nconfidential information in bucket names.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name}: GET Namespace Metadata",
|
|
"api_call": "GET /n/{namespaceName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and\ndefaultSwiftCompartmentId.\n\nAny user with the OBJECTSTORAGE_NAMESPACE_READ permission will be able to see the current metadata. If you are\nnot authorized, talk to an administrator. If you are an administrator who needs to write policies\nto give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name}: PUT Namespace",
|
|
"api_call": "PUT /n/{namespaceName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "By default, buckets created using the Amazon S3 Compatibility API or the Swift API are created in the root\ncompartment of the Oracle Cloud Infrastructure tenancy.\n\nYou can change the default Swift/Amazon S3 compartmentId designation to a different compartmentId. All\nsubsequent bucket creations will use the new default compartment, but no previously created\nbuckets will be modified. A user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default\ncompartments for Amazon S3 and Swift.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n: GET Namespace Name",
|
|
"api_call": "GET /n/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace\nis a system-generated string assigned during account creation. For some older tenancies, the namespace string may be\nthe tenancy name in all lower-case letters. You cannot edit a namespace.\n\nGetNamespace returns the name of the Object Storage namespace for the user making the request.\nIf an optional compartmentId query parameter is provided, GetNamespace returns the namespace name of the corresponding\ntenancy, provided the user has access to it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: GET Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request for the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: Cancel a work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancels a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: List Work Request Errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Lists the errors of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: List Work Request Logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Lists the logs of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list buckets.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests > {workRequestId} > logs: Get work request logs.",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Get the logs of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests > {workRequestId} > errors: Get work request errors.",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Get the errors of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests > {workRequestId}: Get Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > stop: Stop an integration instance that was previously in an ACTIVE state",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Stop an integration instance that was previously in an ACTIVE state\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > start: Start an integration instance that was previously in an INACTIVE state",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Start an integration instance that was previously in an INACTIVE state\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > changeNetworkEndpoint: Change an Integration instance network endpoint.",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/changeNetworkEndpoint",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Change an Integration instance network endpoint. The operation is long-running\nand creates a new WorkRequest.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > changeCompartment: Change the compartment for an integration instance",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Change the compartment for an integration instance\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId}: Delete a provisioned Integration Instance",
|
|
"api_call": "DELETE /integrationInstances/{integrationInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Deletes an Integration Instance resource by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId}: Get Integration Instance",
|
|
"api_call": "GET /integrationInstances/{integrationInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets a IntegrationInstance by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId}: Update the Integration Instance identified by the id",
|
|
"api_call": "PUT /integrationInstances/{integrationInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the Integration Instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances: Gets a list of all Integration Instances in a compartment",
|
|
"api_call": "GET /integrationInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order\nfor TIMECREATED is descending. Default order for DISPLAYNAME is\nascending. If no value is specified TIMECREATED is default.\n"
|
|
},
|
|
"functionality": "Returns a list of Integration Instances.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances: Creates a new Integration Instance",
|
|
"api_call": "POST /integrationInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new Integration Instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id} > distribution Channel Attachments > {distribution Channel Id}: Deletes a MediaAsset from DistributionChannel.",
|
|
"api_call": "DELETE /mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"version": "integer: Version of the attachment.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier",
|
|
"distributionChannelId": "[REQUIRED] string: (Required) Unique DistributionChannel identifier."
|
|
},
|
|
"functionality": "Deletes a MediaAsset from the DistributionChannel by identifiers.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id} > distribution Channel Attachments > {distribution Channel Id}: Get a MediaAssetDistributionChannelAttachment for a MediaAsset.",
|
|
"api_call": "GET /mediaAssets/{mediaAssetId}/distributionChannelAttachments/{distributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"version": "integer: Version of the attachment.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier",
|
|
"distributionChannelId": "[REQUIRED] string: (Required) Unique DistributionChannel identifier."
|
|
},
|
|
"functionality": "Gets a MediaAssetDistributionChannelAttachment for a MediaAsset by identifiers.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id} > distribution Channel Attachments: List MediaAssetDistributionChannelAttachments for MediaAsset.",
|
|
"api_call": "GET /mediaAssets/{mediaAssetId}/distributionChannelAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"displayName": "string: A filter to return only the resources that match the entire display name given.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Lists the MediaAssetDistributionChannelAttachments for a MediaAsset by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Delete a provisioned MediaAsset",
|
|
"api_call": "DELETE /mediaAssets/{mediaAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"deleteMode": "string: DeleteMode decides whether to delete all the immediate children or all assets with the asset's ID as their masterMediaAssetId.",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Deletes a MediaAsset resource by identifier. If DeleteChildren is passed in as the mode, all the assets with the parentMediaAssetId matching the ID will be deleted. If DeleteDerivatives is set as the mode, all the assets with the masterMediaAssetId matching the ID will be deleted.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Get MediaAsset",
|
|
"api_call": "GET /mediaAssets/{mediaAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Gets a MediaAsset by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Update the MediaAsset identified by the ID.",
|
|
"api_call": "PUT /mediaAssets/{mediaAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Updates the MediaAsset.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets > {media Asset Id}: Moves an asset into a different compartment.",
|
|
"api_call": "POST /mediaAssets/{mediaAssetId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaAssetId": "[REQUIRED] string: (Required) Unique MediaAsset identifier"
|
|
},
|
|
"functionality": "Moves a MediaAsset resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets: Gets a list of all MediaAssetSummary in a compartment.",
|
|
"api_call": "GET /mediaAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Returns a list of MediaAssetSummary.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Assets: Creates a new MediaAsset",
|
|
"api_call": "POST /mediaAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new MediaAsset.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Deletes a provisioned MediaWorkflowConfiguration.",
|
|
"api_call": "DELETE /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Deletes a MediaWorkflowConfiguration resource by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Get MediaWorkflowConfiguration",
|
|
"api_call": "GET /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Gets a MediaWorkflowConfiguration by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Update the MediaWorkflowConfiguration identified by the ID.",
|
|
"api_call": "PUT /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Updates the MediaWorkflowConfiguration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations > {media Workflow Configuration Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /mediaWorkflowConfigurations/{mediaWorkflowConfigurationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowConfigurationId": "[REQUIRED] string: (Required) Unique MediaWorkflowConfiguration identifier."
|
|
},
|
|
"functionality": "Moves a MediaWorkflowConfiguration resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations: Gets a list of all MediaWorkflowConfigurations in a compartment.",
|
|
"api_call": "GET /mediaWorkflowConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Returns a list of MediaWorkflowConfigurations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Configurations: Creates a new MediaWorkflowConfiguration.",
|
|
"api_call": "POST /mediaWorkflowConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new MediaWorkflowConfiguration.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id} > facts: List MediaWorkflowJobFacts",
|
|
"api_call": "GET /mediaWorkflowJobs/{mediaWorkflowJobId}/facts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Internal API to get a point-in-time snapshot of a MediaWorkflowJob.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id} > facts: Get a MediaWorkflowJobFact",
|
|
"api_call": "GET /mediaWorkflowJobs/{mediaWorkflowJobId}/facts/{key}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier.",
|
|
"key": "[REQUIRED] integer: (Required) Identifier of the MediaWorkflowJobFact within a MediaWorkflowJob."
|
|
},
|
|
"functionality": "Get the MediaWorkflowJobFact identified by the mediaWorkflowJobId and Fact ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Cancel a MediaWorkflowJob identified by the mediaWorkflowJobId",
|
|
"api_call": "DELETE /mediaWorkflowJobs/{mediaWorkflowJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "This is an asynchronous operation. The MediaWorkflowJob lifecycleState will change to CANCELING temporarily until the job is completely CANCELED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Get MediaWorkflowJob identified by the mediaWorkflowId and jobId",
|
|
"api_call": "GET /mediaWorkflowJobs/{mediaWorkflowJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Gets the MediaWorkflowJob.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Update the MediaWorkflowJob identified by the id",
|
|
"api_call": "PUT /mediaWorkflowJobs/{mediaWorkflowJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Updates the MediaWorkflowJob.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs > {media Workflow Job Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /mediaWorkflowJobs/{mediaWorkflowJobId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowJobId": "[REQUIRED] string: (Required) Unique MediaWorkflowJob identifier."
|
|
},
|
|
"functionality": "Moves a MediaWorkflowJob resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs: List MediaWorkflowJobs in a compartment",
|
|
"api_call": "GET /mediaWorkflowJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"sortBy": "string: The parameter sort by.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'."
|
|
},
|
|
"functionality": "Lists the MediaWorkflowJobs.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflow Jobs: Creates and runs a MediaWorkflowJob for the the MediaWorkflow identified by mediaWorkflowId",
|
|
"api_call": "POST /mediaWorkflowJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Run the MediaWorkflow according to the given mediaWorkflow definition and configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Deletes a MediaWorkflow identified by the mediaWorkflowId.",
|
|
"api_call": "DELETE /mediaWorkflows/{mediaWorkflowId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "The MediaWorkflow lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Gets MediaWorkflow.",
|
|
"api_call": "GET /mediaWorkflows/{mediaWorkflowId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "Gets a MediaWorkflow by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Updates the MediaWorkflow identified by the ID.",
|
|
"api_call": "PUT /mediaWorkflows/{mediaWorkflowId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "Updates the MediaWorkflow.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows > {media Workflow Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /mediaWorkflows/{mediaWorkflowId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"mediaWorkflowId": "[REQUIRED] string: (Required) Unique MediaWorkflow identifier."
|
|
},
|
|
"functionality": "Moves a MediaWorkflow resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows: Lists the MediaWorkflows.",
|
|
"api_call": "GET /mediaWorkflows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the MediaWorkflows.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - media Workflows: Creates a new MediaWorkflow.",
|
|
"api_call": "POST /mediaWorkflows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new MediaWorkflow.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs > {stream Cdn Config Id}: Deletes a StreamCdnConfig identified by the streamCdnConfigId.",
|
|
"api_call": "DELETE /streamCdnConfigs/{streamCdnConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"streamCdnConfigId": "[REQUIRED] string: (Required) Unique StreamCdnConfig identifier."
|
|
},
|
|
"functionality": "The StreamCdnConfig lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs > {stream Cdn Config Id}: Gets StreamCdnConfig.",
|
|
"api_call": "GET /streamCdnConfigs/{streamCdnConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"streamCdnConfigId": "[REQUIRED] string: (Required) Unique StreamCdnConfig identifier."
|
|
},
|
|
"functionality": "Gets a StreamCdnConfig by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs > {stream Cdn Config Id}: Updates the StreamCdnConfig identified by the ID.",
|
|
"api_call": "PUT /streamCdnConfigs/{streamCdnConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamCdnConfigId": "[REQUIRED] string: (Required) Unique StreamCdnConfig identifier."
|
|
},
|
|
"functionality": "Updates the StreamCdnConfig.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs: Lists the StreamCdnConfig.",
|
|
"api_call": "GET /streamCdnConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"distributionChannelId": "string: (Required) The Stream Distribution Channel identifier this CdnConfig belongs to.\n"
|
|
},
|
|
"functionality": "Lists the StreamCdnConfig.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Cdn Configs: Creates a new CDN Configuration.",
|
|
"api_call": "POST /streamCdnConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new CDN Configuration.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id} > actions: Moves a resource into a different compartment.",
|
|
"api_call": "POST /streamDistributionChannels/{streamDistributionChannelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Moves a Stream Distribution Channel resource from one compartment identifier to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id} > actions: Ingests an Asset into a Distribution Channel.",
|
|
"api_call": "POST /streamDistributionChannels/{streamDistributionChannelId}/actions/ingest",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Ingests an Asset into a Distribution Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id}: Deletes a Stream Distribution Channel identified by the streamDistributionChannelId.",
|
|
"api_call": "DELETE /streamDistributionChannels/{streamDistributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "The Stream Distribution Channel lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id}: Gets a Stream Distribution Channel.",
|
|
"api_call": "GET /streamDistributionChannels/{streamDistributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Gets a Stream Distribution Channel by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels > {stream Distribution Channel Id}: Update the Stream Distribution Channel identified by the id",
|
|
"api_call": "PUT /streamDistributionChannels/{streamDistributionChannelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamDistributionChannelId": "[REQUIRED] string: (Required) Unique Stream Distribution Channel path identifier."
|
|
},
|
|
"functionality": "Updates the Stream Distribution Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels: Lists Stream Distribution Channels.",
|
|
"api_call": "GET /streamDistributionChannels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the Stream Distribution Channels.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Distribution Channels: Creates a new Stream Distribution Channel",
|
|
"api_call": "POST /streamDistributionChannels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new Stream Distribution Channel.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs > {stream Packaging Config Id}: Deletes a Stream Packaging Configuration identified by the streamPackagingConfigId.",
|
|
"api_call": "DELETE /streamPackagingConfigs/{streamPackagingConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"streamPackagingConfigId": "[REQUIRED] string: (Required) Unique Stream Packaging Configuration path identifier."
|
|
},
|
|
"functionality": "The Stream Packaging Configuration lifecycleState will change to DELETED.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs > {stream Packaging Config Id}: Get a Stream Packaging Configuration.",
|
|
"api_call": "GET /streamPackagingConfigs/{streamPackagingConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"streamPackagingConfigId": "[REQUIRED] string: (Required) Unique Stream Packaging Configuration path identifier."
|
|
},
|
|
"functionality": "Gets a Stream Packaging Configuration by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs > {stream Packaging Config Id}: Updates the Stream Packaging Configuration identified by the ID.",
|
|
"api_call": "PUT /streamPackagingConfigs/{streamPackagingConfigId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"streamPackagingConfigId": "[REQUIRED] string: (Required) Unique Stream Packaging Configuration path identifier."
|
|
},
|
|
"functionality": "Updates the Stream Packaging Configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs: List Stream Packaging Configurations",
|
|
"api_call": "GET /streamPackagingConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"distributionChannelId": "string: (Required) Unique Stream Distribution Channel identifier."
|
|
},
|
|
"functionality": "Lists the Stream Packaging Configurations.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - stream Packaging Configs: Creates a new Stream Packaging Configuration.",
|
|
"api_call": "POST /streamPackagingConfigs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new Packaging Configuration.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - General: Gets a list of all MediaWorkflowTaskDeclarations.",
|
|
"api_call": "GET /mediaWorkflowTaskDeclarations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'."
|
|
},
|
|
"functionality": "Returns a list of MediaWorkflowTaskDeclarations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Media Services API - General: Lists SystemMediaWorkflows.",
|
|
"api_call": "GET /systemMediaWorkflows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the SystemMediaWorkflows that can be used to run a job by name or as a template to create a MediaWorkflow.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Moves an Digital Assistant instance into a different compartment.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Moves an Digital Assistant instance into a different compartment. When provided, If-Match is checked against\nETag values of the resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Configure the Digital Assistant Parameters for the Digital Assistant instance",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/configureDigitalAssistantParameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "This will store the provided parameters in the Digital Assistant instance and update any Digital Assistants with matching parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Import Bot",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/importBot",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Import a Bot archive from Object Storage.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Starts an inactive Digital Assistant instance.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an inactive Digital Assistant instance. Once active, the instance will be accessible and metering\nof requests will be started again.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > actions: Stops an active Digital Assistant instance.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Stops an active Digital Assistant instance. Once inactive, the instance will not be accessible and metering\nof requests will be stopped until the instance is started again. Data associated with the instance\nis not affected.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments > {attachment Id}: Delete a Digital Assistant instance attachment",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/attachments/{attachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"attachmentId": "[REQUIRED] string: (Required) Unique Digital Assistant instance attachment identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to delete the specified Digital Assistant instance attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments > {attachment Id}: Get ODA instance attachment information",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/attachments/{attachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"includeOwnerMetadata": "boolean: Whether to send attachment owner info during get/list call.",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"attachmentId": "[REQUIRED] string: (Required) Unique Digital Assistant instance attachment identifier."
|
|
},
|
|
"functionality": "Gets an ODA instance attachment by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments > {attachment Id}: Update the ODA instance attachment identified by the ID",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/attachments/{attachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"attachmentId": "[REQUIRED] string: (Required) Unique Digital Assistant instance attachment identifier."
|
|
},
|
|
"functionality": "Updates the ODA instance attachment",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments: Gets a list of all attachments to an ODA instance",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/attachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a list of ODA instance attachments\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > attachments: Create Digital Assistant Instance Attachment",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/attachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to create a Digital Assistant instance attachment.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers > {authentication Provider Id}: Delete Authentication Provider",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"authenticationProviderId": "[REQUIRED] string: (Required) Unique Authentication Provider identifier."
|
|
},
|
|
"functionality": "Delete the specified Authentication Provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers > {authentication Provider Id}: Get Authentication Provider",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"authenticationProviderId": "[REQUIRED] string: (Required) Unique Authentication Provider identifier."
|
|
},
|
|
"functionality": "Gets the specified Authentication Provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers > {authentication Provider Id}: Update Authentication Provider",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/authenticationProviders/{authenticationProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"authenticationProviderId": "[REQUIRED] string: (Required) Unique Authentication Provider identifier."
|
|
},
|
|
"functionality": "Updates the specified Authentication Provider with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers: List Authentication Providers",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/authenticationProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Authentication Providers that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > authentication Providers: Create Authentication Provider",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/authenticationProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Authentication Provider\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id} > actions: Rotate generated keys for the Channel.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels/{channelId}/actions/rotateKeys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "This will generate new keys for any generated keys in the Channel (eg. secretKey, verifyToken).\nIf a Channel has no generated keys then no changes will be made.\nEnsure that you take note of the newly generated keys in the response as they will not be returned again.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id} > actions: Start a Channel.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels/{channelId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Starts a Channel so that it will begin accepting messages.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id} > actions: Stop a Channel.",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels/{channelId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Stops a Channel so that it will no longer accept messages.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id}: Delete Channel",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/channels/{channelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Delete the specified Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id}: Get Channel",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/channels/{channelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Gets the specified Channel.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels > {channel Id}: Update Channel",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/channels/{channelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"channelId": "[REQUIRED] string: (Required) Unique Channel identifier."
|
|
},
|
|
"functionality": "Updates the specified Channel with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels: List Channels",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/channels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Channels that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > channels: Create Channel",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/channels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Channel.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > actions: Export a Digital Assistant to Object Storage",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/export",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Exports the specified Digital Assistant as an archive to Object Storage.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > actions: Publish Digital Assistant",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/actions/publish",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Publish a draft Digital Assistant.\nOnce published the Digital Assistant cannot be modified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > parameters > {parameter Name}: Get Digital Assistant Parameter",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant."
|
|
},
|
|
"functionality": "Gets the specified Digital Assistant Parameter.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > parameters > {parameter Name}: Update Digital Assistant Parameter",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Digital Assistant Parameter. This is unique with the Digital Assistant."
|
|
},
|
|
"functionality": "Updates the specified Digital Assistant Parameter with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id} > parameters: List Digital Assistant Parameters",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}/parameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Returns a page of Parameters that belong to the specified Digital Assistant.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id}: Delete Digital Assistant",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Delete the specified Digital Assistant.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id}: Get Digital Assistant",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Gets the specified Digital Assistant.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants > {digital Assistant Id}: Update Digital Assistant",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/digitalAssistants/{digitalAssistantId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"digitalAssistantId": "[REQUIRED] string: (Required) Unique Digital Assistant identifier."
|
|
},
|
|
"functionality": "Updates the specified Digital Assistant with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants: List Digital Assistants",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/digitalAssistants",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Digital Assistants that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > digital Assistants: Create Digital Assistant",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/digitalAssistants",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Digital Assistant.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages > {package Id}: Delete Package from Digital Assistant Instance",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/importedPackages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to delete a package from a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages > {package Id}: Get details for a package that has been imported into the given instance.",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/importedPackages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Returns a list of summaries for imported packages in the instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages > {package Id}: Update Package that has been imported into a Digital Assistant Instance",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/importedPackages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"isReplaceSkills": "boolean: Should old skills be replaced by new skills if packageId differs from already imported package?",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to update a package within a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages: List packages that have been imported into the given instance.",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/importedPackages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a list of summaries for imported packages in the instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > imported Packages: Import Package into Digital Assistant Instance",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/importedPackages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to import a package into a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > actions: Export a Skill to Object Storage",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills/{skillId}/actions/export",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Exports the specified Skill as an archive to Object Storage.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > actions: Publish Skill",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills/{skillId}/actions/publish",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Publish a draft Skill.\nOnce published it cannot be modified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters > {parameter Name}: Delete Skill Parameter",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Skill Parameter."
|
|
},
|
|
"functionality": "Delete the specified Skill Parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters > {parameter Name}: Get Skill Parameter",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Skill Parameter."
|
|
},
|
|
"functionality": "Gets the specified Skill Parameter.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters > {parameter Name}: Update Skill Parameter",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/skills/{skillId}/parameters/{parameterName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier.",
|
|
"parameterName": "[REQUIRED] string: (Required) The name of a Skill Parameter."
|
|
},
|
|
"functionality": "Updates the specified Skill Parameter with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters: List Skill Parameters",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills/{skillId}/parameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Returns a page of Skill Parameters that belong to the specified Skill.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id} > parameters: Create Skill Parameter",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills/{skillId}/parameters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Creates a new Skill Parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id}: Delete Skill",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/skills/{skillId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Delete the specified Skill.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id}: Get Skill",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills/{skillId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Gets the specified Skill.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills > {skill Id}: Update Skill",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/skills/{skillId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"skillId": "[REQUIRED] string: (Required) Unique Skill identifier."
|
|
},
|
|
"functionality": "Updates the specified Skill with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills: List Skills",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/skills",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Skills that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > skills: Create Skill",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/skills",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Skill from scratch.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators > {translator Id}: Delete Translator",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}/translators/{translatorId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"translatorId": "[REQUIRED] string: (Required) Unique Translator identifier."
|
|
},
|
|
"functionality": "Delete the specified Translator.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators > {translator Id}: Get Translator",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/translators/{translatorId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-none-match": "string: The If-None-Match HTTP request header makes the request conditional. For GET methods, the service will return the \nrequested resource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nWhen the condition fails for GET methods, then the service will return HTTP status code 304 (Not Modified).\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"translatorId": "[REQUIRED] string: (Required) Unique Translator identifier."
|
|
},
|
|
"functionality": "Gets the specified Translator.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators > {translator Id}: Update Translator",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}/translators/{translatorId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"translatorId": "[REQUIRED] string: (Required) Unique Translator identifier."
|
|
},
|
|
"functionality": "Updates the specified Translator with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators: List Translators",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/translators",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Returns a page of Translators that belong to the specified Digital Assistant instance.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id} > translators: Create Translator",
|
|
"api_call": "POST /odaInstances/{odaInstanceId}/translators",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Creates a new Translator\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Delete Digital Assistant Instance",
|
|
"api_call": "DELETE /odaInstances/{odaInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Starts an asynchronous job to delete the specified Digital Assistant instance.\nTo monitor the status of the job, take the `opc-work-request-id` response header value and use it to call `GET /workRequests/{workRequestId}`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Get Digital Assistant Instance",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Gets the specified Digital Assistant instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Update Digital Assistant Instance",
|
|
"api_call": "PUT /odaInstances/{odaInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control in a PUT or DELETE call for\na Digital Assistant instance, set the `if-match` query parameter\nto the value of the `ETAG` header from a previous GET or POST\nresponse for that instance. The service updates or deletes the\ninstance only if the etag that you provide matches the instance's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier."
|
|
},
|
|
"functionality": "Updates the specified Digital Assistant instance with the information in the request body.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances > {oda Instance Id}: Get details for a given package",
|
|
"api_call": "GET /odaInstances/{odaInstanceId}/packages/{packageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "[REQUIRED] string: (Required) Unique Digital Assistant instance identifier.",
|
|
"packageId": "[REQUIRED] string: (Required) Unique Digital Assistant package identifier."
|
|
},
|
|
"functionality": "Returns details about a package, and how to import it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances: Get Compartment's Digital Assistant Instances",
|
|
"api_call": "GET /odaInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) List the Digital Assistant instances that belong to this compartment.",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending)."
|
|
},
|
|
"functionality": "Returns a page of Digital Assistant instances that belong to the specified\ncompartment.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - oda Instances: Create Digital Assistant Instance",
|
|
"api_call": "POST /odaInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so that you can retry the request if there's\na timeout or server error without the risk of executing that same action again.\n\nRetry tokens expire after 24 hours, but they can become invalid before then if there are\nconflicting operations. For example, if an instance was deleted and purged from the system,\nthen the service might reject a retry of the original creation request.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Starts an asynchronous job to create a Digital Assistant instance.\n\nTo monitor the status of the job, take the `opc-work-request-id` response\nheader value and use it to call `GET /workRequests/{workRequestId}`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests > {work Request Id}: Get Work Request",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The identifier of the asynchronous work request."
|
|
},
|
|
"functionality": "Gets information about the work request with the specified ID, including its status.\n\nYou can use this operation to monitor the status of jobs that you\nrequested to create, delete, and update instances.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests > {work Request Id}: List Work Request Errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.\n\nThe default sort order for both `TIMESTAMP` and `CODE` is ascending.\n",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The identifier of the asynchronous work request."
|
|
},
|
|
"functionality": "Returns a page of errors for the specified work request.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests > {work Request Id}: List Work Request Log Messages",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return per page.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. If no value is specified, then the default is `TIMESTAMP`.\n\nThe default sort order for both `TIMESTAMP` and `MESSAGE` is ascending.\n",
|
|
"sortOrder": "string: Sort the results in this order, use either `ASC` (ascending) or `DESC` (descending).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The identifier of the asynchronous work request."
|
|
},
|
|
"functionality": "Returns a page of of log messages for a given work request.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - work Requests: List Compartment's Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) List the Digital Assistant instances that belong to this compartment."
|
|
},
|
|
"functionality": "Returns a page of work requests for the specified compartment.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Digital Assistant Service Instance API - General: List packages available for import",
|
|
"api_call": "GET /packages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing. This value is included in the opc-request-id response header.",
|
|
"Accept": "string",
|
|
"odaInstanceId": "string: List only the information for this Digital Assistant instance."
|
|
},
|
|
"functionality": "Returns a page of summaries for packages that are available for import. The optional odaInstanceId query\nparameter can be used to filter packages that are available for import by a specific instance. If odaInstanceId\nquery parameter is not provided, the returned list will\ninclude packages available within the region indicated by the request URL. The optional resourceType query\nparam may be specified to filter packages that contain the indicated resource type. If no resourceType query\nparam is given, packages containing all resource types will be returned. The optional name query parameter can\nbe used to limit the list to packages whose name matches the given name. The optional displayName query\nparameter can be used to limit the list to packages whose displayName matches the given name. The optional\nisLatestVersionOnly query parameter can be used to limit the returned list to include only the latest version\nof any given package. If not specified, all versions of any otherwise matching package will be returned.\n\nIf the `opc-next-page` header appears in the response, then\nthere are more items to retrieve. To get the next page in the subsequent\nGET request, include the header's value as the `page` query parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {id}: Get Confirm Subscription",
|
|
"api_call": "GET /subscriptions/{id}/confirmation",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"token": "string: (Required) The subscription confirmation token.",
|
|
"protocol": "string: (Required) The protocol used for the subscription.\n\nAllowed values:\n * `CUSTOM_HTTPS`\n * `EMAIL`\n * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)\n * `ORACLE_FUNCTIONS`\n * `PAGERDUTY`\n * `SLACK`\n * `SMS`\n\nFor information about subscription protocols, see\n[To create a subscription](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#concepts__subscriptionprotocols).\n",
|
|
"id": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to get the confirmation details for.\n"
|
|
},
|
|
"functionality": "Gets the confirmation details for the specified subscription.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {id}: Resend Subscription Confirmation",
|
|
"api_call": "POST /subscriptions/{id}/resendConfirmation",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"id": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to resend the confirmation for.\n"
|
|
},
|
|
"functionality": "Resends the confirmation details for the specified subscription.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {id}: Get Unsubscription",
|
|
"api_call": "GET /subscriptions/{id}/unsubscription",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"token": "string: (Required) The subscription confirmation token.",
|
|
"protocol": "string: (Required) The protocol used for the subscription.\n\nAllowed values:\n * `CUSTOM_HTTPS`\n * `EMAIL`\n * `HTTPS` (deprecated; for PagerDuty endpoints, use `PAGERDUTY`)\n * `ORACLE_FUNCTIONS`\n * `PAGERDUTY`\n * `SLACK`\n * `SMS`\n\nFor information about subscription protocols, see\n[To create a subscription](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#concepts__subscriptionprotocols).\n",
|
|
"id": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to unsubscribe from.\n"
|
|
},
|
|
"functionality": "Unsubscribes the subscription from the topic.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Get Subscription",
|
|
"api_call": "GET /subscriptions/{subscriptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to retrieve.\n"
|
|
},
|
|
"functionality": "Gets the specified subscription's configuration information.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Update Subscription",
|
|
"api_call": "PUT /subscriptions/{subscriptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to update.\n"
|
|
},
|
|
"functionality": "Updates the specified subscription's configuration.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Delete Subscription",
|
|
"api_call": "DELETE /subscriptions/{subscriptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to delete.\n"
|
|
},
|
|
"functionality": "Deletes the specified subscription.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions > {subscription Id}: Change Subscription Compartment",
|
|
"api_call": "POST /subscriptions/{subscriptionId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subscriptionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription to move.\n"
|
|
},
|
|
"functionality": "Moves a subscription into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions: List Subscriptions",
|
|
"api_call": "GET /subscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n",
|
|
"topicId": "string: Return all subscriptions that are subscribed to the given topic OCID. Either this query parameter or the compartmentId query parameter must be set.\n",
|
|
"page": "string: For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the subscriptions in the specified compartment or topic.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - subscriptions: Create Subscription",
|
|
"api_call": "POST /subscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in \"Pending\" status until it has been confirmed.\nFor information about confirming subscriptions, see\n[To confirm a subscription](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub).\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Get Topic",
|
|
"api_call": "GET /topics/{topicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to retrieve.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 120.\n"
|
|
},
|
|
"functionality": "Gets the specified topic's configuration information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Update Topic",
|
|
"api_call": "PUT /topics/{topicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to update.\n"
|
|
},
|
|
"functionality": "Updates the specified topic's configuration.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Delete Topic",
|
|
"api_call": "DELETE /topics/{topicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to delete.\n"
|
|
},
|
|
"functionality": "Deletes the specified topic.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Change Topic Compartment",
|
|
"api_call": "POST /topics/{topicId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: Used for optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic to move.\n"
|
|
},
|
|
"functionality": "Moves a topic into a different compartment within the same tenancy. For information about moving resources\nbetween compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics > {topic Id}: Publish Message",
|
|
"api_call": "POST /topics/{topicId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"messageType": "string: **Deprecated.**\nThis attribute is deprecated, as is support for JSON.\nYou can send a JSON payload even when transmitting the payload as a raw string.\nConfigure your receiving system to read the raw payload as JSON format.\n\nType of message body in the request.\nFor `messageType` of JSON, a default key-value pair is required. Example: `{\"default\": \"Alarm breached\", \"Email\": \"Alarm breached: <url>\"}.`\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"topicId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic.\n"
|
|
},
|
|
"functionality": "Publishes a message to the specified topic.\n\nThe topic endpoint is required for this operation.\nTo get the topic endpoint, use [GetTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic/GetTopic)\nand review the `apiEndpoint` value in the response ([NotificationTopic](https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/NotificationTopic)).\n\nLimits information follows.\n\nMessage size limit per request: 64KB.\n\nMessage delivery rate limit per endpoint: 60 messages per minute for HTTP-based protocols, 10 messages per minute for the `EMAIL` protocol.\nHTTP-based protocols use URL endpoints that begin with \"http:\" or \"https:\".\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)\n\nFor more information about publishing messages, see [Publishing Messages](https://docs.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm).\nFor steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics: List Topics",
|
|
"api_call": "GET /topics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.\n",
|
|
"page": "string: For list pagination. The value of the opc-next-page response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. Only one field can be selected for sorting.\n",
|
|
"sortOrder": "string: The sort order to use (ascending or descending).\n",
|
|
"lifecycleState": "string: Filter returned list by specified lifecycle state. This parameter is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists topics in the specified compartment.\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 120.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Notifications API - topics: Create Topic",
|
|
"api_call": "POST /topics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before that due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a topic in the specified compartment. For general information about topics, see\n[Managing Topics and Subscriptions](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm).\n\nFor the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside.\nFor information about access control and compartments, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).\n\nYou must specify a display name for the topic.\n\nAll Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an\nOracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also\nretrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the\nConsole. For more information, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nTransactions Per Minute (TPM) per-tenancy limit for this operation: 60.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Retrieves an application",
|
|
"api_call": "GET /applications/{applicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Retrieves an application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Modifies an application",
|
|
"api_call": "PUT /applications/{applicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Modifies an application",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Deletes an application",
|
|
"api_call": "DELETE /applications/{applicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Deletes an application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications > {application Id}: Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"api_call": "POST /applications/{applicationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"applicationId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this application.\n"
|
|
},
|
|
"functionality": "Moves an application into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see [Moving Resources Between Compartments](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications: Lists applications for a compartment",
|
|
"api_call": "GET /applications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this resource belongs.\n",
|
|
"limit": "integer: The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n",
|
|
"sortOrder": "string: Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n",
|
|
"sortBy": "string: Specifies the attribute with which to sort the rules.\n\nDefault: `displayName`\n\n* **timeCreated:** Sorts by timeCreated.\n* **displayName:** Sorts by displayName.\n* **id:** Sorts by id.\n"
|
|
},
|
|
"functionality": "Lists applications for a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - applications: Creates a new application",
|
|
"api_call": "POST /applications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string"
|
|
},
|
|
"functionality": "Creates a new application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Retrieves a function",
|
|
"api_call": "GET /functions/{functionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Retrieves a function.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Modifies a function",
|
|
"api_call": "PUT /functions/{functionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Modifies a function",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Deletes a function",
|
|
"api_call": "DELETE /functions/{functionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Deletes a function.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions > {function Id}: Invokes a function",
|
|
"api_call": "POST //<unique_ID>.{region}.functions.oci.oraclecloud.com/20181201/functions/{functionId}/actions/invoke",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"region": "[REQUIRED] string",
|
|
"functionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this function.\n"
|
|
},
|
|
"functionality": "Invokes a function",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions: Lists functions for an application",
|
|
"api_call": "GET /functions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"applicationId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the application to which this function belongs.\n",
|
|
"limit": "integer: The maximum number of items to return. 1 is the minimum, 50 is the maximum.\n\nDefault: 10\n",
|
|
"page": "string: The pagination token for a list query returned by a previous operation\n",
|
|
"sortOrder": "string: Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n",
|
|
"sortBy": "string: Specifies the attribute with which to sort the rules.\n\nDefault: `displayName`\n\n* **timeCreated:** Sorts by timeCreated.\n* **displayName:** Sorts by displayName.\n* **id:** Sorts by id.\n"
|
|
},
|
|
"functionality": "Lists functions for an application.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Functions Service API - functions: Creates a new function",
|
|
"api_call": "POST /functions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string"
|
|
},
|
|
"functionality": "Creates a new function.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - authentication Policies/{compartment Id}: GetAuthenticationPolicy",
|
|
"api_call": "GET /authenticationPolicies/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Gets the authentication policy for the given tenancy. You must specify your tenant\u2019s OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - authentication Policies/{compartment Id}: UpdateAuthenticationPolicy",
|
|
"api_call": "PUT /authenticationPolicies/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Updates authentication policy for the specified tenancy\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: Bulk delete resources in the compartment",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/bulkDeleteResources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Deletes multiple resources in the compartment. All resources must be in the same compartment. You must have the appropriate\npermissions to delete the resources in the request. This API can only be invoked from the tenancy's\n[home region](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingregions.htm#Home). This operation creates a\n[WorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/). Use the [GetWorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest)\nAPI to monitor the status of the bulk action.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: Move multiple resources at once to a different compartment.",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/bulkMoveResources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Moves multiple resources from one compartment to another. All resources must be in the same compartment.\nThis API can only be invoked from the tenancy's [home region](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingregions.htm#Home).\nTo move resources, you must have the appropriate permissions to move the resource in both the source and target\ncompartments. This operation creates a [WorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/).\nUse the [GetWorkRequest](https://docs.oracle.com/iaas/api/#/en/workrequests/20160918/WorkRequest/GetWorkRequest) API to monitor the status of the bulk action.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: Moves a compartment tree to a different parent compartment. When provided,\nIf-Match is checked against ETag values of the resource.\n",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/moveCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Move the compartment to a different parent compartment in the same tenancy. When you move a\ncompartment, all its contents (subcompartments and resources) are moved with it. Note that\nthe `CompartmentId` that you specify in the path is the compartment that you want to move.\n\n**IMPORTANT**: After you move a compartment to a new parent compartment, the access policies of\nthe new parent take effect and the policies of the previous parent no longer apply. Ensure that you\nare aware of the implications for the compartment contents before you move it. For more\ninformation, see [Moving a Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#MoveCompartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id} > actions: RecoverCompartment",
|
|
"api_call": "POST /compartments/{compartmentId}/actions/recoverCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Recover the compartment from DELETED state to ACTIVE state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id}: DeleteCompartment",
|
|
"api_call": "DELETE /compartments/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Deletes the specified compartment. The compartment must be empty.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id}: GetCompartment",
|
|
"api_call": "GET /compartments/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Gets the specified compartment's information.\n\nThis operation does not return a list of all the resources inside the compartment. There is no single\nAPI operation that does that. Compartments can contain multiple types of resources (instances, block\nstorage volumes, etc.). To find out what's in a compartment, you must call the \"List\" operation for\neach resource type and specify the compartment's OCID as a query parameter in the request. For example,\ncall the [ListInstances](https://docs.oracle.com/iaas/api/#/en/iaas/20160918/Instance/ListInstances) operation in the Cloud Compute\nService or the [ListVolumes](https://docs.oracle.com/iaas/api/#/en/iaas/20160918/Volume/ListVolumes) operation in Cloud Block Storage.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments > {compartment Id}: UpdateCompartment",
|
|
"api_call": "PUT /compartments/{compartmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "[REQUIRED] string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Updates the specified compartment's description or name. You can't update the root compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments: ListCompartments",
|
|
"api_call": "GET /compartments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"accessLevel": "string: Valid values are `ANY` and `ACCESSIBLE`. Default is `ANY`.\nSetting this to `ACCESSIBLE` returns only those compartments for which the\nuser has INSPECT permissions directly or indirectly (permissions can be on a\nresource in a subcompartment). For the compartments on which the user indirectly has\nINSPECT permissions, a restricted set of fields is returned.\n\nWhen set to `ANY` permissions are not checked.\n",
|
|
"compartmentIdInSubtree": "boolean: Default is false. Can only be set to true when performing\nListCompartments on the tenancy (root compartment).\nWhen set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\nreturned depending on the the setting of `accessLevel`.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the compartments in a specified compartment. The members of the list\nreturned depends on the values set for several parameters.\n\nWith the exception of the tenancy (root compartment), the ListCompartments operation\nreturns only the first-level child compartments in the parent compartment specified in\n`compartmentId`. The list does not include any subcompartments of the child\ncompartments (grandchildren).\n\nThe parameter `accessLevel` specifies whether to return only those compartments for which the\nrequestor has INSPECT permissions on at least one resource directly\nor indirectly (the resource can be in a subcompartment).\n\nThe parameter `compartmentIdInSubtree` applies only when you perform ListCompartments on the\ntenancy (root compartment). When set to true, the entire hierarchy of compartments can be returned.\nTo get a full list of all compartments and subcompartments in the tenancy (root compartment),\nset the parameter `compartmentIdInSubtree` to true and `accessLevel` to ANY.\n\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments: CreateCompartment",
|
|
"api_call": "POST /compartments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new compartment in the specified compartment.\n\n**Important:** Compartments cannot be deleted.\n\nSpecify the parent compartment's OCID as the compartment ID in the request object. Remember that the tenancy\nis simply the root compartment. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the compartment, which must be unique across all compartments in\nyour tenancy. You can use this name or the OCID when writing policies that apply\nto the compartment. For more information about policies, see\n[How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the compartment (although it can be an empty string). It does\nnot have to be unique, and you can change it anytime with\n[UpdateCompartment](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Compartment/UpdateCompartment).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - compartments: ListBulkActionResourceTypes",
|
|
"api_call": "GET /compartments/bulkActionResourceTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bulkActionType": "string: (Required) The type of bulk action.\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the resource-types supported by compartment bulk actions. Use this API to help you provide the correct\nresource-type information to the [BulkDeleteResources](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Compartment/BulkDeleteResources/)\nand [BulkMoveResources](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Compartment/BulkMoveResources/) operations. The returned list of\nresource-types provides the appropriate resource-type names to use with the bulk action operations along with\nthe type of identifying information you'll need to provide for each resource-type. Most resource-types just\nrequire an [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) to identify a specific resource, but some resource-types,\nsuch as buckets, require you to provide other identifying information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups > {dynamic Group Id}: DeleteDynamicGroup",
|
|
"api_call": "DELETE /dynamicGroups/{dynamicGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dynamicGroupId": "[REQUIRED] string: (Required) The OCID of the dynamic group."
|
|
},
|
|
"functionality": "Deletes the specified dynamic group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups > {dynamic Group Id}: GetDynamicGroup",
|
|
"api_call": "GET /dynamicGroups/{dynamicGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dynamicGroupId": "[REQUIRED] string: (Required) The OCID of the dynamic group."
|
|
},
|
|
"functionality": "Gets the specified dynamic group's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups > {dynamic Group Id}: UpdateDynamicGroup",
|
|
"api_call": "PUT /dynamicGroups/{dynamicGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dynamicGroupId": "[REQUIRED] string: (Required) The OCID of the dynamic group."
|
|
},
|
|
"functionality": "Updates the specified dynamic group.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups: ListDynamicGroups",
|
|
"api_call": "GET /dynamicGroups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the dynamic groups in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - dynamic Groups: CreateDynamicGroup",
|
|
"api_call": "POST /dynamicGroups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new dynamic group in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the dynamic group, which must be unique across all dynamic groups in your\ntenancy, and cannot be changed. Note that this name has to be also unique across all groups in your tenancy.\nYou can use this name or the OCID when writing policies that apply to the dynamic group. For more information\nabout policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the dynamic group (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdateDynamicGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/DynamicGroup/UpdateDynamicGroup).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups > {group Id}: DeleteGroup",
|
|
"api_call": "DELETE /groups/{groupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"groupId": "[REQUIRED] string: (Required) The OCID of the group."
|
|
},
|
|
"functionality": "Deletes the specified group. The group must be empty.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups > {group Id}: GetGroup",
|
|
"api_call": "GET /groups/{groupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"groupId": "[REQUIRED] string: (Required) The OCID of the group."
|
|
},
|
|
"functionality": "Gets the specified group's information.\n\nThis operation does not return a list of all the users in the group. To do that, use\n[ListUserGroupMemberships](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UserGroupMembership/ListUserGroupMemberships) and\nprovide the group's OCID as a query parameter in the request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups > {group Id}: UpdateGroup",
|
|
"api_call": "PUT /groups/{groupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"groupId": "[REQUIRED] string: (Required) The OCID of the group."
|
|
},
|
|
"functionality": "Updates the specified group.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups: ListGroups",
|
|
"api_call": "GET /groups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the groups in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - groups: CreateGroup",
|
|
"api_call": "POST /groups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new group in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the group, which must be unique across all groups in your tenancy and\ncannot be changed. You can use this name or the OCID when writing policies that apply to the group. For more\ninformation about policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the group (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdateGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Group/UpdateGroup).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n\nAfter creating the group, you need to put users in it and write policies for it.\nSee [AddUserToGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UserGroupMembership/AddUserToGroup) and\n[CreatePolicy](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Policy/CreatePolicy).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings > {mapping Id}: DeleteIdpGroupMapping",
|
|
"api_call": "DELETE /identityProviders/{identityProviderId}/groupMappings/{mappingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider.",
|
|
"mappingId": "[REQUIRED] string: (Required) The OCID of the group mapping."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nDeletes the specified group mapping.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings > {mapping Id}: GetIdpGroupMapping",
|
|
"api_call": "GET /identityProviders/{identityProviderId}/groupMappings/{mappingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider.",
|
|
"mappingId": "[REQUIRED] string: (Required) The OCID of the group mapping."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nGets the specified group mapping.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings > {mapping Id}: UpdateIdpGroupMapping",
|
|
"api_call": "PUT /identityProviders/{identityProviderId}/groupMappings/{mappingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider.",
|
|
"mappingId": "[REQUIRED] string: (Required) The OCID of the group mapping."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nUpdates the specified group mapping.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings: ListIdpGroupMappings",
|
|
"api_call": "GET /identityProviders/{identityProviderId}/groupMappings/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists the group mappings for the specified identity provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id} > group Mappings: CreateIdpGroupMapping",
|
|
"api_call": "POST /identityProviders/{identityProviderId}/groupMappings/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nCreates a single mapping between an IdP group and an IAM Service\n[group](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Group/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: DeleteIdentityProvider",
|
|
"api_call": "DELETE /identityProviders/{identityProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nDeletes the specified identity provider. The identity provider must not have\nany group mappings (see [IdpGroupMapping](https://docs.oracle.com/iaas/api/#/en/identity/20160918/IdpGroupMapping/)).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: GetIdentityProvider",
|
|
"api_call": "GET /identityProviders/{identityProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nGets the specified identity provider's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: UpdateIdentityProvider",
|
|
"api_call": "PUT /identityProviders/{identityProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nUpdates the specified identity provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: ResetIdpScimClient",
|
|
"api_call": "POST /identityProviders/{identityProviderId}/actions/resetScimClient/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "Resets the OAuth2 client credentials for the SCIM client associated with this identity provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers > {identity Provider Id}: Gets the identity provider groups.",
|
|
"api_call": "GET /identityProviders/{identityProviderId}/groups/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"name": "string: A filter to only return resources that match the given name exactly.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n",
|
|
"identityProviderId": "[REQUIRED] string: (Required) The OCID of the identity provider."
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists the identity provider groups.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers: ListIdentityProviders",
|
|
"api_call": "GET /identityProviders/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"protocol": "string: (Required) The protocol used for federation.",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nLists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for\nidentity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the\ncompartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - identity Providers: CreateIdentityProvider",
|
|
"api_call": "POST /identityProviders/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "**Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm).\n\nCreates a new identity provider in your tenancy. For more information, see\n[Identity Providers and Federation](https://docs.oracle.com/iaas/Content/Identity/Concepts/federation.htm).\n\nYou must specify your tenancy's OCID as the compartment ID in the request object.\nRemember that the tenancy is simply the root compartment. For information about\nOCIDs, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the `IdentityProvider`, which must be unique\nacross all `IdentityProvider` objects in your tenancy and cannot be changed.\n\nYou must also specify a *description* for the `IdentityProvider` (although\nit can be an empty string). It does not have to be unique, and you can change\nit anytime with\n[UpdateIdentityProvider](https://docs.oracle.com/iaas/api/#/en/identity/20160918/IdentityProvider/UpdateIdentityProvider).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily\nbe CREATING. Before using the object, first make sure its `lifecycleState` has\nchanged to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources > {network Source Id}: DeleteNetworkSource",
|
|
"api_call": "DELETE /networkSources/{networkSourceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSourceId": "[REQUIRED] string: (Required) The OCID of the network source."
|
|
},
|
|
"functionality": "Deletes the specified network source\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources > {network Source Id}: GetNetworkSource",
|
|
"api_call": "GET /networkSources/{networkSourceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSourceId": "[REQUIRED] string: (Required) The OCID of the network source."
|
|
},
|
|
"functionality": "Gets the specified network source's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources > {network Source Id}: UpdateNetworkSource",
|
|
"api_call": "PUT /networkSources/{networkSourceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSourceId": "[REQUIRED] string: (Required) The OCID of the network source."
|
|
},
|
|
"functionality": "Updates the specified network source.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources: ListNetworkSources",
|
|
"api_call": "GET /networkSources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the network sources in your tenancy. You must specify your tenancy's OCID as the value for\nthe compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - network Sources: CreateNetworkSource",
|
|
"api_call": "POST /networkSources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new network source in your tenancy.\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the tenancy\nis simply the root compartment). Notice that IAM resources (users, groups, compartments, and some policies)\nreside within the tenancy itself, unlike cloud resources such as compute instances, which typically\nreside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the network source, which must be unique across all network sources in your\ntenancy, and cannot be changed.\nYou can use this name or the OCID when writing policies that apply to the network source. For more information\nabout policies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm).\n\nYou must also specify a *description* for the network source (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdateNetworkSource](https://docs.oracle.com/iaas/api/#/en/identity/20160918/NetworkSource/UpdateNetworkSource).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n\nAfter your network resource is created, you can use it in policy to restrict access to only requests made from an allowed\nIP address specified in your network source. For more information, see [Managing Network Sources](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingnetworksources.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies > {policy Id}: DeletePolicy",
|
|
"api_call": "DELETE /policies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the policy."
|
|
},
|
|
"functionality": "Deletes the specified policy. The deletion takes effect typically within 10 seconds.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies > {policy Id}: GetPolicy",
|
|
"api_call": "GET /policies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the policy."
|
|
},
|
|
"functionality": "Gets the specified policy's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies > {policy Id}: UpdatePolicy",
|
|
"api_call": "PUT /policies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the policy."
|
|
},
|
|
"functionality": "Updates the specified policy. You can update the description or the policy statements themselves.\n\nPolicy changes take effect typically within 10 seconds.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies: ListPolicies",
|
|
"api_call": "GET /policies/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the policies in the specified compartment (either the tenancy or another of your compartments).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n\nTo determine which policies apply to a particular group or compartment, you must view the individual\nstatements inside all your policies. There isn't a way to automatically obtain that information via the API.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - policies: CreatePolicy",
|
|
"api_call": "POST /policies/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new policy in the specified compartment (either the tenancy or another of your compartments).\nIf you're new to policies, see [Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n\nYou must specify a *name* for the policy, which must be unique across all policies in your tenancy\nand cannot be changed.\n\nYou must also specify a *description* for the policy (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with [UpdatePolicy](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Policy/UpdatePolicy).\n\nYou must specify one or more policy statements in the statements array. For information about writing\npolicies, see [How Policies Work](https://docs.oracle.com/iaas/Content/Identity/Concepts/policies.htm) and\n[Common Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/commonpolicies.htm).\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n\nNew policies take effect typically within 10 seconds.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults > {tag Default Id}: DeleteTagDefault",
|
|
"api_call": "DELETE /tagDefaults/{tagDefaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagDefaultId": "[REQUIRED] string: (Required) The OCID of the tag default."
|
|
},
|
|
"functionality": "Deletes the the specified tag default.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults > {tag Default Id}: GetTagDefault",
|
|
"api_call": "GET /tagDefaults/{tagDefaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagDefaultId": "[REQUIRED] string: (Required) The OCID of the tag default."
|
|
},
|
|
"functionality": "Retrieves the specified tag default.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults > {tag Default Id}: UpdateTagDefault",
|
|
"api_call": "PUT /tagDefaults/{tagDefaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagDefaultId": "[REQUIRED] string: (Required) The OCID of the tag default."
|
|
},
|
|
"functionality": "Updates the specified tag default. If you specify that a value is required, a value is set\nduring resource creation (either by the user creating the resource or another tag defualt).\nIf no value is set, resource creation is blocked.\n\n* If the `isRequired` flag is set to \"true\", the value is set during resource creation.\n* If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults: ListTagDefaults",
|
|
"api_call": "GET /tagDefaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"compartmentId": "string: The OCID of the compartment (remember that the tenancy is simply the root compartment).\n"
|
|
},
|
|
"functionality": "Lists the tag defaults for tag definitions in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults: CreateTagDefault",
|
|
"api_call": "POST /tagDefaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new tag default in the specified compartment for the specified tag definition.\n\nIf you specify that a value is required, a value is set during resource creation (either by\nthe user creating the resource or another tag defualt). If no value is set, resource creation\nis blocked.\n\n* If the `isRequired` flag is set to \"true\", the value is set during resource creation.\n* If the `isRequired` flag is set to \"false\", the value you enter is set during resource creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Defaults: AssembleEffectiveTagSet",
|
|
"api_call": "GET /tagDefaults/actions/assembleEffectiveTagSet",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n"
|
|
},
|
|
"functionality": "Assembles tag defaults in the specified compartment and any parent compartments to determine\nthe tags to apply. Tag defaults from parent compartments do not override tag defaults\nreferencing the same tag in a compartment lower down the hierarchy. This set of tag defaults\nincludes all tag defaults from the current compartment back to the root compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > actions: Delete tag namespace that contains tags",
|
|
"api_call": "POST /tagNamespaces/{tagNamespaceId}/actions/cascadeDelete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Deletes the specified tag namespace. This operation triggers a process that removes all of the tags\ndefined in the specified tag namespace from all resources in your tenancy and then deletes the tag namespace.\n\nAfter you start the delete operation:\n\n * New tag key definitions cannot be created under the namespace.\n * The state of the tag namespace changes to DELETING.\n * Tag removal from the resources begins.\n\nThis process can take up to 48 hours depending on the number of tag definitions in the namespace, the number of resources\nthat are tagged, and the locations of the regions in which those resources reside.\n\nAfter all tags are removed, the state changes to DELETED. You cannot restore a deleted tag namespace. After the deleted tag namespace\nchanges its state to DELETED, you can use the name of the deleted tag namespace again.\n\nAfter you start this operation, you cannot start either the [DeleteTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/DeleteTag) or the [BulkDeleteTags](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/BulkDeleteTags) operation until this process completes.\n\nTo delete a tag namespace, you must first retire it. Use [UpdateTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/UpdateTagNamespace)\nto retire a tag namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > actions: changes compartment of a tag namespace.",
|
|
"api_call": "POST /tagNamespaces/{tagNamespaceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Moves the specified tag namespace to the specified compartment within the same tenancy.\n\nTo move the tag namespace, you must have the manage tag-namespaces permission on both compartments.\nFor more information about IAM policies, see [Details for IAM](https://docs.oracle.com/iaas/Content/Identity/Reference/iampolicyreference.htm).\n\nMoving a tag namespace moves all the tag key definitions contained in the tag namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags > {tag Name}: DeleteTag",
|
|
"api_call": "DELETE /tagNamespaces/{tagNamespaceId}/tags/{tagName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n",
|
|
"tagName": "[REQUIRED] string: (Required) The name of the tag.\n"
|
|
},
|
|
"functionality": "Deletes the specified tag definition. This operation triggers a process that removes the\ntag from all resources in your tenancy.\n\nThese things happen immediately:\n\u00a0\n * If the tag was a cost-tracking tag, it no longer counts against your 10 cost-tracking\n tags limit, whether you first disabled it or not.\n * If the tag was used with dynamic groups, none of the rules that contain the tag will\n be evaluated against the tag.\n\nWhen you start the delete operation, the state of the tag changes to DELETING and tag removal\nfrom resources begins. This can take up to 48 hours depending on the number of resources that\nwere tagged as well as the regions in which those resources reside.\n\nWhen all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. Once the deleted tag\nchanges its state to DELETED, you can use the same tag name again.\n\nAfter you start this operation, you cannot start either the [BulkDeleteTags](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/BulkDeleteTags) or the [CascadeDeleteTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) operation until this process completes.\n\nTo delete a tag, you must first retire it. Use [UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/latest/Tag/UpdateTag)\nto retire a tag.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags > {tag Name}: GetTag",
|
|
"api_call": "GET /tagNamespaces/{tagNamespaceId}/tags/{tagName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n",
|
|
"tagName": "[REQUIRED] string: (Required) The name of the tag.\n"
|
|
},
|
|
"functionality": "Gets the specified tag's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags > {tag Name}: UpdateTag",
|
|
"api_call": "PUT /tagNamespaces/{tagNamespaceId}/tags/{tagName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n",
|
|
"tagName": "[REQUIRED] string: (Required) The name of the tag.\n"
|
|
},
|
|
"functionality": "Updates the specified tag definition.\n\nSetting `validator` determines the value type. Tags can use either a static value or a\nlist of possible values. Static values are entered by a user applying the tag to a resource.\nLists are created by you and the user must apply a value from the list. On update, any values\nin a list that were previously set do not change, but new values must pass validation. Values\nalready applied to a resource do not change.\n\nYou cannot remove list values that appear in a TagDefault. To remove a list value that\nappears in a TagDefault, first update the TagDefault to use a different value.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags: ListTags",
|
|
"api_call": "GET /tagNamespaces/{tagNamespaceId}/tags",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Lists the tag definitions in the specified tag namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id} > tags: CreateTag",
|
|
"api_call": "POST /tagNamespaces/{tagNamespaceId}/tags",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Creates a new tag in the specified tag namespace.\n\nThe tag requires either the OCID or the name of the tag namespace that will contain this\ntag definition.\n\nYou must specify a *name* for the tag, which must be unique across all tags in the tag namespace\nand cannot be changed. The name can contain any ASCII character except the space (_) or period (.) characters.\nNames are case insensitive. That means, for example, \"myTag\" and \"mytag\" are not allowed in the same namespace.\nIf you specify a name that's already in use in the tag namespace, a 409 error is returned.\n\nThe tag must have a *description*. It does not have to be unique, and you can change it with\n[UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/latest/Tag/UpdateTag).\n\nThe tag must have a value type, which is specified with a validator. Tags can use either a\nstatic value or a list of possible values. Static values are entered by a user applying the tag\nto a resource. Lists are created by you and the user must apply a value from the list. Lists\nare validiated.\n\n* If no `validator` is set, the user applying the tag to a resource can type in a static\nvalue or leave the tag value empty.\n* If a `validator` is set, the user applying the tag to a resource must select from a list\nof values that you supply with [EnumTagDefinitionValidator](https://docs.oracle.com/iaas/api/#/en/identity/latest/datatypes/EnumTagDefinitionValidator).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id}: DeleteTagNamespace",
|
|
"api_call": "DELETE /tagNamespaces/{tagNamespaceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Deletes the specified tag namespace. Only an empty tag namespace can be deleted with this operation. To use this operation\nto delete a tag namespace that contains tag definitions, first delete all of its tag definitions.\n\nUse [CascadeDeleteTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) to delete a tag namespace along with all of\nthe tag definitions contained within that namespace.\n\nUse [DeleteTag](https://docs.oracle.com/iaas/api/#/en/identity/latest/Tag/DeleteTag) to delete a tag definition.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id}: GetTagNamespace",
|
|
"api_call": "GET /tagNamespaces/{tagNamespaceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Gets the specified tag namespace's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces > {tag Namespace Id}: UpdateTagNamespace",
|
|
"api_call": "PUT /tagNamespaces/{tagNamespaceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tagNamespaceId": "[REQUIRED] string: (Required) The OCID of the tag namespace.\n"
|
|
},
|
|
"functionality": "Updates the the specified tag namespace. You can't update the namespace name.\n\nUpdating `isRetired` to 'true' retires the namespace and all the tag definitions in the namespace. Reactivating a\nnamespace (changing `isRetired` from 'true' to 'false') does not reactivate tag definitions.\nTo reactivate the tag definitions, you must reactivate each one individually *after* you reactivate the namespace,\nusing [UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/UpdateTag). For more information about retiring tag namespaces, see\n[Retiring Key Definitions and Namespace Definitions](https://docs.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#Retiring).\n\nYou can't add a namespace with the same name as a retired namespace in the same tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces: ListTagNamespaces",
|
|
"api_call": "GET /tagNamespaces",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"includeSubcompartments": "boolean: An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this\nparameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.\n"
|
|
},
|
|
"functionality": "Lists the tag namespaces in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces: CreateTagNamespace",
|
|
"api_call": "POST /tagNamespaces",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new tag namespace in the specified compartment.\n\nYou must specify the compartment ID in the request object (remember that the tenancy is simply the root\ncompartment).\n\nYou must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy\nand cannot be changed. The name can contain any ASCII character except the space (_) or period (.).\nNames are case insensitive. That means, for example, \"myNamespace\" and \"mynamespace\" are not allowed\nin the same tenancy. Once you created a namespace, you cannot change the name.\nIf you specify a name that's already in use in the tenancy, a 409 error is returned.\n\nYou must also specify a *description* for the namespace.\nIt does not have to be unique, and you can change it with\n[UpdateTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/latest/TagNamespace/UpdateTagNamespace).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tag Namespaces: ListCostTrackingTags",
|
|
"api_call": "GET /tagNamespaces/actions/listCostTrackingTags",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists all the tags enabled for cost-tracking in the specified tenancy. For information about\ncost-tracking tags, see [Using Cost-tracking Tags](https://docs.oracle.com/iaas/Content/Identity/Concepts/taggingoverview.htm#costs).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests > {work Request Id}: GetTaggingWorkRequest",
|
|
"api_call": "GET /taggingWorkRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header\nfor any asynchronous operation in the Identity and Access Management service.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests > {work Request Id}: ListTaggingWorkRequestErrors",
|
|
"api_call": "GET /taggingWorkRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets the errors for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests > {work Request Id}: ListTaggingWorkRequestLogs",
|
|
"api_call": "GET /taggingWorkRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets the logs for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tagging Work Requests: ListTaggingWorkRequests",
|
|
"api_call": "GET /taggingWorkRequests/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the tagging work requests in compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tags > actions: Delete multiple tag key definitions at the same time",
|
|
"api_call": "POST /tags/actions/bulkDelete",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Deletes the specified tag key definitions. This operation triggers a process that removes the\ntags from all resources in your tenancy. The tag key definitions must be within the same tag namespace.\n\nThe following actions happen immediately:\n\u00a0\n * If the tag is a cost-tracking tag, the tag no longer counts against your\n 10 cost-tracking tags limit, even if you do not disable the tag before running this operation.\n * If the tag is used with dynamic groups, the rules that contain the tag are no longer\n evaluated against the tag.\n\nAfter you start this operation, the state of the tag changes to DELETING, and tag removal\nfrom resources begins. This process can take up to 48 hours depending on the number of resources that\nare tagged and the regions in which those resources reside.\n\nWhen all tags have been removed, the state changes to DELETED. You cannot restore a deleted tag. After the tag state\nchanges to DELETED, you can use the same tag name again.\n\nAfter you start this operation, you cannot start either the [DeleteTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/DeleteTag) or the [CascadeDeleteTagNamespace](https://docs.oracle.com/iaas/api/#/en/identity/20160918/TagNamespace/CascadeDeleteTagNamespace) operation until this process completes.\n\nIn order to delete tags, you must first retire the tags. Use [UpdateTag](https://docs.oracle.com/iaas/api/#/en/identity/20160918/Tag/UpdateTag)\nto retire a tag.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tags > actions: Edit multiple tag key definitions on resources",
|
|
"api_call": "POST /tags/actions/bulkEdit",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Edits the specified list of tag key definitions for the selected resources. \nThis operation triggers a process that edits the tags on all selected resources. The possible actions are:\n\n * Add a defined tag when the tag does not already exist on the resource.\n * Update the value for a defined tag when the tag is present on the resource.\n * Add a defined tag when it does not already exist on the resource or update the value for a defined tag when the tag is present on the resource.\n * Remove a defined tag from a resource. The tag is removed from the resource regardless of the tag value.\n\nSee [BulkEditOperationDetails](https://docs.oracle.com/iaas/api/#/en/identity/latest/datatypes/BulkEditOperationDetails) for more information.\n\nThe edits can include a combination of operations and tag sets. \nHowever, multiple operations cannot apply to one key definition in the same request.\nFor example, if one request adds `tag set-1` to a resource and sets a tag value to `tag set-2`, \n`tag set-1` and `tag set-2` cannot have any common tag definitions.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tags: ListBulkEditTagsResourceTypes",
|
|
"api_call": "GET /tags/bulkEditResourceTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the resource types that support bulk tag editing.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tenancies/{tenancy Id} > region Subscriptions: ListRegionSubscriptions",
|
|
"api_call": "GET /tenancies/{tenancyId}/regionSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tenancyId": "[REQUIRED] string: (Required) The OCID of the tenancy."
|
|
},
|
|
"functionality": "Lists the region subscriptions for the specified tenancy.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tenancies/{tenancy Id} > region Subscriptions: CreateRegionSubscription",
|
|
"api_call": "POST /tenancies/{tenancyId}/regionSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"tenancyId": "[REQUIRED] string: (Required) The OCID of the tenancy."
|
|
},
|
|
"functionality": "Creates a subscription to a region for a tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - tenancies/{tenancy Id}: GetTenancy",
|
|
"api_call": "GET /tenancies/{tenancyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"tenancyId": "[REQUIRED] string: (Required) The OCID of the tenancy."
|
|
},
|
|
"functionality": "Get the specified tenancy's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships > {user Group Membership Id}: RemoveUserFromGroup",
|
|
"api_call": "DELETE /userGroupMemberships/{userGroupMembershipId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userGroupMembershipId": "[REQUIRED] string: (Required) The OCID of the userGroupMembership."
|
|
},
|
|
"functionality": "Removes a user from a group by deleting the corresponding `UserGroupMembership`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships > {user Group Membership Id}: GetUserGroupMembership",
|
|
"api_call": "GET /userGroupMemberships/{userGroupMembershipId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userGroupMembershipId": "[REQUIRED] string: (Required) The OCID of the userGroupMembership."
|
|
},
|
|
"functionality": "Gets the specified UserGroupMembership's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships: ListUserGroupMemberships",
|
|
"api_call": "GET /userGroupMemberships/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"userId": "string: The OCID of the user.",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the `UserGroupMembership` objects in your tenancy. You must specify your tenancy's OCID\nas the value for the compartment ID\n(see [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five)).\nYou must also then filter the list in one of these ways:\n\n- You can limit the results to just the memberships for a given user by specifying a `userId`.\n- Similarly, you can limit the results to just the memberships for a given group by specifying a `groupId`.\n- You can set both the `userId` and `groupId` to determine if the specified user is in the specified group.\nIf the answer is no, the response is an empty list.\n- Although`userId` and `groupId` are not individually required, you must set one of them.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - user Group Memberships: AddUserToGroup",
|
|
"api_call": "POST /userGroupMemberships/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Adds the specified user to the specified group and returns a `UserGroupMembership` object with its own OCID.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the\nobject, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > api Keys: ListApiKeys",
|
|
"api_call": "GET /users/{userId}/apiKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the API signing keys for the specified user. A user can have a maximum of three keys.\n\nEvery user has permission to use this API call for *their own user ID*. An administrator in your\norganization does not need to write a policy to give users this ability.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > api Keys: UploadApiKey",
|
|
"api_call": "POST /users/{userId}/apiKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Uploads an API signing key for the specified user.\n\nEvery user has permission to use this operation to upload a key for *their own user ID*. An\nadministrator in your organization does not need to write a policy to give users this ability.\nTo compare, administrators who have permission to the tenancy can use this operation to upload a\nkey for any user, including themselves.\n\n**Important:** Even though you have permission to upload an API key, you might not yet\nhave permission to do much else. If you try calling an operation unrelated to your own credential\nmanagement (e.g., `ListUsers`, `LaunchInstance`) and receive an \"unauthorized\" error,\ncheck with an administrator to confirm which IAM Service group(s) you're in and what access\nyou have. Also confirm you're working in the correct compartment.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using\nthe object, first make sure its `lifecycleState` has changed to ACTIVE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > api Keys: DeleteApiKey",
|
|
"api_call": "DELETE /users/{userId}/apiKeys/{fingerprint}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"fingerprint": "[REQUIRED] string: (Required) The key's fingerprint."
|
|
},
|
|
"functionality": "Deletes the specified API signing key for the specified user.\n\nEvery user has permission to use this operation to delete a key for *their own user ID*. An\nadministrator in your organization does not need to write a policy to give users this ability.\nTo compare, administrators who have permission to the tenancy can use this operation to delete\na key for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens > {auth Token Id}: DeleteAuthToken",
|
|
"api_call": "DELETE /users/{userId}/authTokens/{authTokenId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"authTokenId": "[REQUIRED] string: (Required) The OCID of the auth token."
|
|
},
|
|
"functionality": "Deletes the specified auth token for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens > {auth Token Id}: UpdateAuthToken",
|
|
"api_call": "PUT /users/{userId}/authTokens/{authTokenId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"authTokenId": "[REQUIRED] string: (Required) The OCID of the auth token."
|
|
},
|
|
"functionality": "Updates the specified auth token's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens: ListAuthTokens",
|
|
"api_call": "GET /users/{userId}/authTokens/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the auth tokens for the specified user. The returned object contains the token's OCID, but not\nthe token itself. The actual token is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > auth Tokens: CreateAuthToken",
|
|
"api_call": "POST /users/{userId}/authTokens/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new auth token for the specified user. For information about what auth tokens are for, see\n[Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the auth token (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/UpdateAuthToken).\n\nEvery user has permission to create an auth token for *their own user ID*. An administrator in your organization\ndoes not need to write a policy to give users this ability. To compare, administrators who have permission to the\ntenancy can use this operation to create an auth token for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys > {customer Secret Key Id}: DeleteCustomerSecretKey",
|
|
"api_call": "DELETE /users/{userId}/customerSecretKeys/{customerSecretKeyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"customerSecretKeyId": "[REQUIRED] string: (Required) The OCID of the secret key."
|
|
},
|
|
"functionality": "Deletes the specified secret key for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys > {customer Secret Key Id}: UpdateCustomerSecretKey",
|
|
"api_call": "PUT /users/{userId}/customerSecretKeys/{customerSecretKeyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"customerSecretKeyId": "[REQUIRED] string: (Required) The OCID of the secret key."
|
|
},
|
|
"functionality": "Updates the specified secret key's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys: ListCustomerSecretKeys",
|
|
"api_call": "GET /users/{userId}/customerSecretKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the secret keys for the specified user. The returned object contains the secret key's OCID, but not\nthe secret key itself. The actual secret key is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > customer Secret Keys: CreateCustomerSecretKey",
|
|
"api_call": "POST /users/{userId}/customerSecretKeys/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new secret key for the specified user. Secret keys are used for authentication with the Object Storage Service's Amazon S3\ncompatible API. The secret key consists of an Access Key/Secret Key pair. For information, see\n[Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the secret key (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateCustomerSecretKey](https://docs.oracle.com/iaas/api/#/en/identity/20160918/CustomerSecretKeySummary/UpdateCustomerSecretKey).\n\nEvery user has permission to create a secret key for *their own user ID*. An administrator in your organization\ndoes not need to write a policy to give users this ability. To compare, administrators who have permission to the\ntenancy can use this operation to create a secret key for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id} > actions: ActivateMfaTotpDevice",
|
|
"api_call": "POST /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Activates the specified MFA TOTP device for the user. Activation requires manual interaction with the Console.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id} > actions: GenerateTotpSeed",
|
|
"api_call": "POST /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}/actions/generateSeed",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Generate seed for the MFA TOTP device.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id}: DeleteMfaTotpDevice",
|
|
"api_call": "DELETE /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Deletes the specified MFA TOTP device for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices > {mfa Totp Device Id}: GetMfaTotpDevice",
|
|
"api_call": "GET /users/{userId}/mfaTotpDevices/{mfaTotpDeviceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"mfaTotpDeviceId": "[REQUIRED] string: (Required) The OCID of the MFA TOTP device."
|
|
},
|
|
"functionality": "Get the specified MFA TOTP device for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices: ListMfaTotpDevices",
|
|
"api_call": "GET /users/{userId}/mfaTotpDevices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the MFA TOTP devices for the specified user. The returned object contains the device's OCID, but not\nthe seed. The seed is returned only upon creation or when the IAM service regenerates the MFA seed for the device.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > mfa Totp Devices: CreateMfaTotpDevice",
|
|
"api_call": "POST /users/{userId}/mfaTotpDevices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new MFA TOTP device for the user. A user can have one MFA TOTP device.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials > {oauth2Client Credential Id}: Delete Oauth token for the user",
|
|
"api_call": "DELETE /users/{userId}/oauth2ClientCredentials/{oauth2ClientCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"oauth2ClientCredentialId": "[REQUIRED] string: (Required) The ID of the Oauth credential."
|
|
},
|
|
"functionality": "Delete Oauth token for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials > {oauth2Client Credential Id}: Updates Oauth token for the user",
|
|
"api_call": "PUT /users/{userId}/oauth2ClientCredentials/{oauth2ClientCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"oauth2ClientCredentialId": "[REQUIRED] string: (Required) The ID of the Oauth credential."
|
|
},
|
|
"functionality": "Updates Oauth token for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials: List of Oauth tokens for the user",
|
|
"api_call": "GET /users/{userId}/oauth2ClientCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "List of Oauth tokens for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > oauth2Client Credentials: Creates Oauth token for the user",
|
|
"api_call": "POST /users/{userId}/oauth2ClientCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates Oauth token for the user\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials > {smtp Credential Id}: DeleteSmtpCredential",
|
|
"api_call": "DELETE /users/{userId}/smtpCredentials/{smtpCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"smtpCredentialId": "[REQUIRED] string: (Required) The OCID of the SMTP credential."
|
|
},
|
|
"functionality": "Deletes the specified SMTP credential for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials > {smtp Credential Id}: UpdateSmtpCredential",
|
|
"api_call": "PUT /users/{userId}/smtpCredentials/{smtpCredentialId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"smtpCredentialId": "[REQUIRED] string: (Required) The OCID of the SMTP credential."
|
|
},
|
|
"functionality": "Updates the specified SMTP credential's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials: ListSmtpCredentials",
|
|
"api_call": "GET /users/{userId}/smtpCredentials/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Lists the SMTP credentials for the specified user. The returned object contains the credential's OCID,\nthe SMTP user name but not the SMTP password. The SMTP password is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > smtp Credentials: CreateSmtpCredential",
|
|
"api_call": "POST /users/{userId}/smtpCredentials/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new SMTP credential for the specified user. An SMTP credential has an SMTP user name and an SMTP password.\nYou must specify a *description* for the SMTP credential (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateSmtpCredential](https://docs.oracle.com/iaas/api/#/en/identity/20160918/SmtpCredentialSummary/UpdateSmtpCredential).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords > {swift Password Id}: DeleteSwiftPassword",
|
|
"api_call": "DELETE /users/{userId}/swiftPasswords/{swiftPasswordId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"swiftPasswordId": "[REQUIRED] string: (Required) The OCID of the Swift password."
|
|
},
|
|
"functionality": "**Deprecated. Use [DeleteAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/DeleteAuthToken) instead.**\n\nDeletes the specified Swift password for the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords > {swift Password Id}: UpdateSwiftPassword",
|
|
"api_call": "PUT /users/{userId}/swiftPasswords/{swiftPasswordId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user.",
|
|
"swiftPasswordId": "[REQUIRED] string: (Required) The OCID of the Swift password."
|
|
},
|
|
"functionality": "**Deprecated. Use [UpdateAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/UpdateAuthToken) instead.**\n\nUpdates the specified Swift password's description.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords: ListSwiftPasswords",
|
|
"api_call": "GET /users/{userId}/swiftPasswords/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "**Deprecated. Use [ListAuthTokens](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/ListAuthTokens) instead.**\n\nLists the Swift passwords for the specified user. The returned object contains the password's OCID, but not\nthe password itself. The actual password is returned only upon creation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id} > swift Passwords: CreateSwiftPassword",
|
|
"api_call": "POST /users/{userId}/swiftPasswords/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "**Deprecated. Use [CreateAuthToken](https://docs.oracle.com/iaas/api/#/en/identity/20160918/AuthToken/CreateAuthToken) instead.**\n\nCreates a new Swift password for the specified user. For information about what Swift passwords are for, see\n[Managing User Credentials](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcredentials.htm).\n\nYou must specify a *description* for the Swift password (although it can be an empty string). It does not\nhave to be unique, and you can change it anytime with\n[UpdateSwiftPassword](https://docs.oracle.com/iaas/api/#/en/identity/20160918/SwiftPassword/UpdateSwiftPassword).\n\nEvery user has permission to create a Swift password for *their own user ID*. An administrator in your organization\ndoes not need to write a policy to give users this ability. To compare, administrators who have permission to the\ntenancy can use this operation to create a Swift password for any user, including themselves.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: DeleteUser",
|
|
"api_call": "DELETE /users/{userId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Deletes the specified user. The user must not be in any groups.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: GetUser",
|
|
"api_call": "GET /users/{userId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Gets the specified user's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: UpdateUser",
|
|
"api_call": "PUT /users/{userId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Updates the description of the specified user.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: UpdateUserCapabilities",
|
|
"api_call": "PUT /users/{userId}/capabilities/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Updates the capabilities of the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: UpdateUserState",
|
|
"api_call": "PUT /users/{userId}/state/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Updates the state of the specified user.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users > {user Id}: CreateOrResetUIPassword",
|
|
"api_call": "POST /users/{userId}/uiPassword",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"userId": "[REQUIRED] string: (Required) The OCID of the user."
|
|
},
|
|
"functionality": "Creates a new Console one-time password for the specified user. For more information about user\ncredentials, see [User Credentials](https://docs.oracle.com/iaas/Content/Identity/Concepts/usercredentials.htm).\n\nUse this operation after creating a new user, or if a user forgets their password. The new one-time\npassword is returned to you in the response, and you must securely deliver it to the user. They'll\nbe prompted to change this password the next time they sign in to the Console. If they don't change\nit within 7 days, the password will expire and you'll need to create a new one-time password for the\nuser.\n\n**Note:** The user's Console login is the unique name you specified when you created the user\n(see [CreateUser](https://docs.oracle.com/iaas/api/#/en/identity/20160918/User/CreateUser)).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users: ListUsers",
|
|
"api_call": "GET /users/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the users in your tenancy. You must specify your tenancy's OCID as the value for the\ncompartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - users: CreateUser",
|
|
"api_call": "POST /users/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (e.g., if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new user in your tenancy. For conceptual information about users, your tenancy, and other\nIAM Service components, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).\n\nYou must specify your tenancy's OCID as the compartment ID in the request object (remember that the\ntenancy is simply the root compartment). Notice that IAM resources (users, groups, compartments, and\nsome policies) reside within the tenancy itself, unlike cloud resources such as compute instances,\nwhich typically reside within compartments inside the tenancy. For information about OCIDs, see\n[Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must also specify a *name* for the user, which must be unique across all users in your tenancy\nand cannot be changed. Allowed characters: No spaces. Only letters, numerals, hyphens, periods,\nunderscores, +, and @. If you specify a name that's already in use, you'll get a 409 error.\nThis name will be the user's login to the Console. You might want to pick a\nname that your company's own identity system (e.g., Active Directory, LDAP, etc.) already uses.\nIf you delete a user and then create a new user with the same name, they'll be considered different\nusers because they have different OCIDs.\n\nYou must also specify a *description* for the user (although it can be an empty string).\nIt does not have to be unique, and you can change it anytime with\n[UpdateUser](https://docs.oracle.com/iaas/api/#/en/identity/20160918/User/UpdateUser). You can use the field to provide the user's\nfull name, a description, a nickname, or other information to generally identify the user.\n\nAfter you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before\nusing the object, first make sure its `lifecycleState` has changed to ACTIVE.\n\nA new user has no permissions until you place the user in one or more groups (see\n[AddUserToGroup](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UserGroupMembership/AddUserToGroup)). If the user needs to\naccess the Console, you need to provide the user a password (see\n[CreateOrResetUIPassword](https://docs.oracle.com/iaas/api/#/en/identity/20160918/UIPassword/CreateOrResetUIPassword)).\nIf the user needs to access the Oracle Cloud Infrastructure REST API, you need to upload a\npublic API signing key for that user (see\n[Required Keys and OCIDs](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm) and also\n[UploadApiKey](https://docs.oracle.com/iaas/api/#/en/identity/20160918/ApiKey/UploadApiKey)).\n\n**Important:** Make sure to inform the new user which compartment(s) they have access to.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - work Requests: ListWorkRequests",
|
|
"api_call": "GET /workRequests/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call.\n"
|
|
},
|
|
"functionality": "Lists the work requests in compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - work Requests: GetWorkRequest",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Gets details on a specified work request. The workRequestID is returned in the opc-workrequest-id header\nfor any asynchronous operation in the Identity and Access Management service.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - General: ListAvailabilityDomains",
|
|
"api_call": "GET /availabilityDomains/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n"
|
|
},
|
|
"functionality": "Lists the availability domains in your tenancy. Specify the OCID of either the tenancy or another\nof your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\nNote that the order of the results returned can change if availability domains are added or removed; therefore, do not\ncreate a dependency on the list order.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - General: ListFaultDomains",
|
|
"api_call": "GET /faultDomains/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment (remember that the tenancy is simply the root compartment).\n",
|
|
"availabilityDomain": "string: (Required) The name of the availibilityDomain.\n"
|
|
},
|
|
"functionality": "Lists the Fault Domains in your tenancy. Specify the OCID of either the tenancy or another\nof your compartments as the value for the compartment ID (remember that the tenancy is simply the root compartment).\nSee [Where to Get the Tenancy's OCID and User's OCID](https://docs.oracle.com/iaas/Content/API/Concepts/apisigningkey.htm#five).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Identity and Access Management Service API - General: ListRegions",
|
|
"api_call": "GET /regions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header"
|
|
},
|
|
"functionality": "Lists all the regions offered by Oracle Cloud Infrastructure.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > configuration: GetContainerConfiguration",
|
|
"api_call": "GET /container/configuration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Get container configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > configuration: UpdateContainerConfiguration",
|
|
"api_call": "PUT /container/configuration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Update container configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures > {image Signature Id}: DeleteContainerImageSignature",
|
|
"api_call": "DELETE /container/imageSignatures/{imageSignatureId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageSignatureId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image signature.\n\nExample: `ocid1.containersignature.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Delete a container image signature.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures > {image Signature Id}: GetContainerImageSignature",
|
|
"api_call": "GET /container/imageSignatures/{imageSignatureId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageSignatureId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image signature.\n\nExample: `ocid1.containersignature.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Get container image signature metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures: ListContainerImageSignatures",
|
|
"api_call": "GET /container/imageSignatures",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentIdInSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"imageId": "string: A filter to return a container image summary only for the specified container image OCID.\n",
|
|
"repositoryId": "string: A filter to return container images only for the specified container repository OCID.\n",
|
|
"repositoryName": "string: A filter to return container images or container image signatures that match the repository name.\n\nExample: `foo` or `foo*`\n",
|
|
"imageDigest": "string: The digest of the container image.\n\nExample: `sha256:e7d38b3517548a1c71e41bffe9c8ae6d6d29546ce46bf62159837aad072c90aa`\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "List container image signatures in an image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > image Signatures: CreateContainerImageSignature",
|
|
"api_call": "POST /container/imageSignatures",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Upload a signature to an image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id} > actions: RemoveContainerVersion",
|
|
"api_call": "POST /container/images/{imageId}/actions/removeVersion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Remove version from container image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id} > actions: RestoreContainerImage",
|
|
"api_call": "POST /container/images/{imageId}/actions/restore",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Restore a container image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id}: DeleteContainerImage",
|
|
"api_call": "DELETE /container/images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Delete a container image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images > {image Id}: GetContainerImage",
|
|
"api_call": "GET /container/images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container image.\n\nExample: `ocid1.containerimage.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Get container image metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > images: ListContainerImages",
|
|
"api_call": "GET /container/images",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentIdInSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "List container images in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: DeleteContainerRepository",
|
|
"api_call": "DELETE /container/repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Delete container repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: GetContainerRepository",
|
|
"api_call": "GET /container/repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Get container repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: UpdateContainerRepository",
|
|
"api_call": "PUT /container/repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Modify the properties of a container repository. Avoid entering confidential information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories > {repository Id}: ChangeContainerRepositoryCompartment",
|
|
"api_call": "POST /container/repositories/{repositoryId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the container repository.\n\nExample: `ocid1.containerrepo.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Moves a container repository into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories: ListContainerRepositories",
|
|
"api_call": "GET /container/repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentIdInSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand all compartments and subcompartments in the tenancy are\ninspected depending on the the setting of `accessLevel`.\nDefault is false. Can only be set to true when calling the API\non the tenancy (root compartment).\n",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "List container repositories in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - container > repositories: CreateContainerRepository",
|
|
"api_call": "POST /container/repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new empty container repository. Avoid entering confidential information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts > {artifact Id}: DeleteGenericArtifact",
|
|
"api_call": "DELETE /generic/artifacts/{artifactId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"artifactId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Deletes an artifact with a specified [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts > {artifact Id}: GetGenericArtifact",
|
|
"api_call": "GET /generic/artifacts/{artifactId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"artifactId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Gets information about an artifact with a specified [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts > {artifact Id}: UpdateGenericArtifact",
|
|
"api_call": "PUT /generic/artifacts/{artifactId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"artifactId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the artifact.\n\nExample: `ocid1.genericartifact.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Updates the artifact with the specified [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). You can only update the tags of an artifact.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > artifacts: ListGenericArtifacts",
|
|
"api_call": "GET /generic/artifacts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"repositoryId": "string: (Required) A filter to return the artifacts only for the specified repository OCID.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists artifacts in the specified repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > repositories/{repository Id}/artifact Paths/{artifact Path}/versions/{version}: DeleteGenericArtifactByPath",
|
|
"api_call": "DELETE /generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n",
|
|
"artifactPath": "[REQUIRED] string: (Required) A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n",
|
|
"version": "[REQUIRED] string: (Required) A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n"
|
|
},
|
|
"functionality": "Deletes an artifact with a specified `artifactPath` and `version`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > repositories/{repository Id}/artifact Paths/{artifact Path}/versions/{version}: GetGenericArtifactByPath",
|
|
"api_call": "GET /generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n",
|
|
"artifactPath": "[REQUIRED] string: (Required) A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n",
|
|
"version": "[REQUIRED] string: (Required) A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n"
|
|
},
|
|
"functionality": "Gets information about an artifact with a specified `artifactPath` and `version`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - generic > repositories/{repository Id}/artifact Paths/{artifact Path}/versions/{version}: UpdateGenericArtifactByPath",
|
|
"api_call": "PUT /generic/repositories/{repositoryId}/artifactPaths/{artifactPath}/versions/{version}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n",
|
|
"artifactPath": "[REQUIRED] string: (Required) A user-defined path to describe the location of an artifact. You can use slashes to organize the repository, but slashes do not create a directory structure. An artifact path does not include an artifact version.\n\nExample: `project01/my-web-app/artifact-abc`\n",
|
|
"version": "[REQUIRED] string: (Required) A user-defined string to describe the artifact version.\n\nExample: `1.1.2` or `1.2-beta-2`\n"
|
|
},
|
|
"functionality": "Updates an artifact with a specified `artifactPath` and `version`. You can only update the tags of an artifact.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: DeleteRepository",
|
|
"api_call": "DELETE /repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Deletes the specified repository. This operation fails unless all associated artifacts are in a DELETED state. You must delete all associated artifacts before deleting a repository.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: GetRepository",
|
|
"api_call": "GET /repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Gets the specified repository's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: UpdateRepository",
|
|
"api_call": "PUT /repositories/{repositoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Updates the properties of a repository. You can update the `displayName` and `description` properties.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories > {repository Id}: ChangeRepositoryCompartment",
|
|
"api_call": "POST /repositories/{repositoryId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"repositoryId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the repository.\n\nExample: `ocid1.artifactrepository.oc1..exampleuniqueID`\n"
|
|
},
|
|
"functionality": "Moves a repository into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories: ListRepositories",
|
|
"api_call": "GET /repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists repositories in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Artifacts and Container Images API - repositories: CreateRepository",
|
|
"api_call": "POST /repositories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new repository for storing artifacts.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - actions > embedText: Produces embeddings (i.e. low-level numerical representation) of the inputs",
|
|
"api_call": "POST /actions/embedText",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**EmbedText**\n\nProduces embeddings (low-level numerical representation) of the inputs\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - actions > generateText: Generates text response based on the prompts",
|
|
"api_call": "POST /actions/generateText",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GenerateText**\n\nGenerates text response based on the prompts\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - actions > summarizeText: Summarizes text response based on the input",
|
|
"api_call": "POST /actions/summarizeText",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**SummarizeText**\n\nSummarizes text response based on the input\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId} > actions > changeCompartment: Moves a DedicatedAiCluster into a different compartment.",
|
|
"api_call": "POST /dedicatedAiClusters/{dedicatedAiClusterId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ChangeDedicatedAiClusterCompartment**\n\nMoves a dedicated AI cluster into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId}: Deletes a dedicated AI cluster.",
|
|
"api_call": "DELETE /dedicatedAiClusters/{dedicatedAiClusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**DeleteDedicatedAiCluster**\n\nDeletes a dedicated AI cluster.\n\nYou can only delete clusters without attached resources. Before you delete a dedicated AI cluster, you must delete the hosted models or endpoints attached to that cluster. The delete action permanently deletes the cluster. This action can't be undone.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId}: Get DedicatedAiCluster",
|
|
"api_call": "GET /dedicatedAiClusters/{dedicatedAiClusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetDedicatedAiCluster**\n\nGets information about a dedicated AI cluster.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters > {dedicatedAiClusterId}: Updates a DedicatedAiCluster.",
|
|
"api_call": "PUT /dedicatedAiClusters/{dedicatedAiClusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"dedicatedAiClusterId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the dedicated AI cluster."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**UpdateDedicatedAiCluster**\n\nUpdates a dedicated AI cluster.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters: Gets a list of DedicatedAiClusters.",
|
|
"api_call": "GET /dedicatedAiClusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"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`\nis descending. Default order for `displayName` is ascending.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListDedicatedAiClusters**\n\nLists the dedicated AI clusters in a specific compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - dedicatedAiClusters: Creates a DedicatedAiCluster.",
|
|
"api_call": "POST /dedicatedAiClusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**CreateDedicatedAiCluster**\n\nCreates a dedicated AI cluster.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId} > actions > changeCompartment: Moves an endpoint into a different compartment.",
|
|
"api_call": "POST /endpoints/{endpointId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ChangeEndpointCompartment**\n\nMoves an endpoint into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId}: Deletes an endpoint.",
|
|
"api_call": "DELETE /endpoints/{endpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**DeleteEndpoint**\n\nDeletes an endpoint.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId}: Get Endpoint",
|
|
"api_call": "GET /endpoints/{endpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetEndpoint**\n\nGets information about an endpoint.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints > {endpointId}: Updates a Endpoint.",
|
|
"api_call": "PUT /endpoints/{endpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"endpointId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the Endpoint."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**UpdateEndpoint**\n\nUpdates the properties of an endpoint.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints: Gets a list of Endpoints.",
|
|
"api_call": "GET /endpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"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`\nis descending. Default order for `displayName` is ascending.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListEndpoints**\n\nList the endpoints of a specific compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - endpoints: Creates a Endpoint.",
|
|
"api_call": "POST /endpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**CreateEndpoint**\n\nCreates an endpoint.\nHeaders contain opc-work-request-id that identifies a WorkRequest which tracks the Endpoint creation progress.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId} > actions > changeCompartment: Moves a Model into a different compartment.",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ChangeModelCompartment**\n\nMoves a custom model into a different compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId}: Deletes a Model.",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**DeleteModel**\n\nDeletes a custom model. A model shouldn't be deleted if there's one or more active endpoints associated with the model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId}: Retrieves a single model resource, providing basic information about the model",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetModel**\n\nGets information about a custom model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models > {modelId}: Updates a Model.",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the\n`if-match` parameter to the value of the etag from a previous GET or POST response for\nthat resource. The resource will be updated or deleted only if the etag you provide\nmatches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) model OCID"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**UpdateModel**\n\nUpdates the properties of a custom model such as name, description, freeform tags and defined tags.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models: Lists the currently available models.",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"capability": "string: A filter to return only resources their capability matches the given capability.",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"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.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListModels**\n\nLists the models in a specific compartment. Includes both pretrained base models and fine-tuned custom models.\nModelCollection is to conform to OCI API consistency guidelines.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - models: Creates a Model.",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of running that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and removed from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**CreateModel**\n\nCreates a custom model to use for fine-tuning. \n\nHeaders contain opc-work-request-id that identifies a WorkRequest which tracks the Model creation progress.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests > {workRequestId} > errors: List work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListWorkRequestErrors**\n\nLists the errors for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests > {workRequestId} > logs: Lists the work request logs.",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListWorkRequestLogs**\n\nLists the logs for a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests > {workRequestId}: Get work request status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request."
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**GetWorkRequest**\n\nGets the details of a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Generative AI Service API (pre-GA) - workRequests: List work requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\nThe only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n"
|
|
},
|
|
"functionality": "**Pre-General Availability\\: 2023-09-18**\n|*Important*|\n|-\n|*The following legal notice applies to Oracle pre-GA (Beta) releases. For copyright and other applicable notices, see [Oracle Legal Notices](https://docs.oracle.com/iaas/Content/legalnotices.htm).*\n\n|*Pre-General Availability Draft Documentation Notice*|\n|-\n|*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\u2019s 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.*\n**ListWorkRequests**\n\nLists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id} > actions: Change Alarm Compartment",
|
|
"api_call": "POST /alarms/{alarmId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Moves an alarm into a different compartment within the same tenancy.\n\nFor information about moving resources between compartments, see [Moving Resources Between Compartments](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id} > actions: Removes any existing suppression for the specified alarm.\n",
|
|
"api_call": "POST /alarms/{alarmId}/actions/removeSuppression",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Removes any existing suppression for the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Get Alarm",
|
|
"api_call": "GET /alarms/{alarmId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Gets the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Updates an alarm.\n",
|
|
"api_call": "PUT /alarms/{alarmId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Updates the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Deletes an alarm.\n",
|
|
"api_call": "DELETE /alarms/{alarmId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Deletes the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms > {alarm Id}: Get Alarm History",
|
|
"api_call": "GET /alarms/{alarmId}/history",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"alarmHistorytype": "string: The type of history entries to retrieve. State history (STATE_HISTORY) or state transition history (STATE_TRANSITION_HISTORY).\nIf not specified, entries of both types are retrieved.\n\nExample: `STATE_HISTORY`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"timestampGreaterThanOrEqualTo": "number: A filter to return only alarm history entries with timestamps occurring on or after the specified date and time. Format defined by RFC3339.\n\nExample: `2019-01-01T01:00:00.789Z`\n",
|
|
"timestampLessThan": "number: A filter to return only alarm history entries with timestamps occurring before the specified date and time. Format defined by RFC3339.\n\nExample: `2019-01-02T01:00:00.789Z`\n",
|
|
"alarmId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm.\n"
|
|
},
|
|
"functionality": "Get the history of the specified alarm.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms: List Alarms",
|
|
"api_call": "GET /alarms",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.\n",
|
|
"lifecycleState": "string: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.\n",
|
|
"sortBy": "string: The field to use when sorting returned alarm definitions. Only one sorting level is provided.\n\nExample: `severity`\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
|
|
},
|
|
"functionality": "Lists the alarms for the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms: Creates a new alarm in the specified compartment.\n",
|
|
"api_call": "POST /alarms",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new alarm in the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - alarms: List Alarms Status",
|
|
"api_call": "GET /alarms/status",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"sortBy": "string: The field to use when sorting returned alarm definitions. Only one sorting level is provided.\n\nExample: `severity`\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned alarm definitions. Ascending (ASC) or descending (DESC).\n\nExample: `ASC`\n"
|
|
},
|
|
"functionality": "List the status of each alarm in the specified compartment.\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nThis call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations.\nMonitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests,\nor transactions, per second (TPS) for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - metrics > actions: List metrics based on matching criteria.",
|
|
"api_call": "POST /metrics/actions/listMetrics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\nFor important details about how pagination works, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nDefault: 1000\n\nExample: 500\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
|
|
},
|
|
"functionality": "Returns metric definitions that match the criteria specified in the request. Compartment OCID required.\nFor information about metrics, see [Metrics Overview](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#MetricsOverview).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nTransactions Per Second (TPS) per-tenancy limit for this operation: 10.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - metrics > actions: Summarizes and returns metrics data filtered using the provided query expression and compartmentId.",
|
|
"api_call": "POST /metrics/actions/summarizeMetricsData",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the\nresources monitored by the metric that you are searching for. Use tenancyId to search in\nthe root compartment.\n\nExample: `ocid1.compartment.oc1..exampleuniqueID`\n",
|
|
"compartmentIdInSubtree": "boolean: When true, returns resources from all compartments and subcompartments. The parameter can\nonly be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment).\nA true value requires the user to have tenancy-level permissions. If this requirement is not met,\nthen the call is rejected. When false, returns resources from only the compartment specified in\ncompartmentId. Default is false.\n"
|
|
},
|
|
"functionality": "Returns aggregated data that match the criteria specified in the request. Compartment OCID required.\nFor information on metric queries, see [Building Metric Queries](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/buildingqueries.htm).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nTransactions Per Second (TPS) per-tenancy limit for this operation: 10.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Monitoring API - metrics: Publishes raw metric data points to the Monitoring service.\n",
|
|
"api_call": "POST /metrics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Customer part of the request identifier token. If you need to contact Oracle about a particular\nrequest, please provide the complete request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Publishes raw metric data points to the Monitoring service.\nFor more information about publishing metrics, see [Publishing Custom Metrics](https://docs.oracle.com/iaas/Content/Monitoring/Tasks/publishingcustommetrics.htm).\nFor important limits information, see [Limits on Monitoring](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#Limits).\n\nPer-call limits information follows.\n\n* Dimensions per metric group*. Maximum: 20. Minimum: 1.\n* Unique metric streams*. Maximum: 50.\n* Transactions Per Second (TPS) per-tenancy limit for this operation: 50.\n\n*A metric group is the combination of a given metric, metric namespace, and tenancy for the purpose of determining limits.\nA dimension is a qualifier provided in a metric definition.\nA metric stream is an individual set of aggregated data for a metric, typically specific to a resource.\nFor more information about metric-related concepts, see [Monitoring Concepts](https://docs.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#concepts).\n\nThe endpoints for this operation differ from other Monitoring operations. Replace the string `telemetry` with `telemetry-ingestion` in the endpoint, as in the following example:\n\nhttps://telemetry-ingestion.eu-frankfurt-1.oraclecloud.com\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Delete a private reverse connection endpoint.",
|
|
"api_call": "DELETE /aiPrivateEndpoints/{aiPrivateEndpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Deletes a private reverse connection endpoint by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Get private reverse connection endpoint.",
|
|
"api_call": "GET /aiPrivateEndpoints/{aiPrivateEndpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Gets a specific private reverse connection by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Update the private reverse connection endpoint identified by the id.",
|
|
"api_call": "PUT /aiPrivateEndpoints/{aiPrivateEndpointId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Updates the private reverse connection endpoint.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints > {ai Private Endpoint Id}: Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.",
|
|
"api_call": "POST /aiPrivateEndpoints/{aiPrivateEndpointId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"aiPrivateEndpointId": "[REQUIRED] string: (Required) Unique private reverse connection identifier."
|
|
},
|
|
"functionality": "Moves a resource into a different compartment. When provided, 'If-Match' is checked against 'ETag' values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints: Lists all the AI private endpoints in the specified compartment",
|
|
"api_call": "GET /aiPrivateEndpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"displayName": "string: A filter to return only resources that match the entire display name given.",
|
|
"id": "string: unique AiPrivateEndpoint identifier",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
|
|
},
|
|
"functionality": "Returns a list of all the AI private endpoints in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - ai Private Endpoints: Create a new private reverse connection endpoint.",
|
|
"api_call": "POST /aiPrivateEndpoints",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new private reverse connection endpoint.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Delete a provisioned DataAsset",
|
|
"api_call": "DELETE /dataAssets/{dataAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Deletes a DataAsset resource by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Get DataAsset",
|
|
"api_call": "GET /dataAssets/{dataAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Gets a DataAsset by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Update the DataAsset identified by the id",
|
|
"api_call": "PUT /dataAssets/{dataAssetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Updates the DataAsset",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets > {data Asset Id}: Change Data Asset Compartment",
|
|
"api_call": "POST /dataAssets/{dataAssetId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dataAssetId": "[REQUIRED] string: (Required) The OCID of the Data Asset."
|
|
},
|
|
"functionality": "Changing the compartment of a data asset.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets: Gets a list of all DataAssets in a compartment",
|
|
"api_call": "GET /dataAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"projectId": "string: The ID of the project for which to list the objects.",
|
|
"displayName": "string: A filter to return only resources that match the entire display name given.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n"
|
|
},
|
|
"functionality": "Returns a list of DataAssets.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - data Assets: Creates a new DataAsset",
|
|
"api_call": "POST /dataAssets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new DataAsset.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Delete a provisioned Model",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Deletes an ai model resource by identifier. This operation fails with a 409 error unless all associated resources are in a DELETED state. You must delete all associated resources before deleting a project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Get a Model",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Gets a Model by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Update the Model identified by the id",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Updates the Model",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models > {model Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The OCID of the Model."
|
|
},
|
|
"functionality": "Moves a Model resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models: Gets a list of all Models in a compartment",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"projectId": "string: The ID of the project for which to list the objects.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of Models.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - models: Creates a new Model for training with the training data",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new Model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Delete a provisioned Project",
|
|
"api_call": "DELETE /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Deletes a Project resource by identifier. This operation fails with a 409 error unless all associated resources (models deployments or data assets) are in a DELETED state. You must delete all associated resources before deleting a project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Get Project",
|
|
"api_call": "GET /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Gets a Project by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Update the Project identified by the id",
|
|
"api_call": "PUT /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Updates the Project",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects > {project Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /projects/{projectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The OCID of the Project."
|
|
},
|
|
"functionality": "Moves a Project resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects: Gets a list of all Projects in a compartment.",
|
|
"api_call": "GET /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of Projects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - projects: Creates a new Project in the compartment.",
|
|
"api_call": "POST /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new Project.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: Cancel the work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancel work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: GET Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"workRequestId": "string: The ID of the asynchronous work request.",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Anomaly Detection API - General: Detect Anomalies with an anomaly model and detection data",
|
|
"api_call": "POST /actions/detectAnomalies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Make a detect call with an anomaly model and detection data",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - actions: Perform document analysis",
|
|
"api_call": "POST /actions/analyzeDocument",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Perform different types of image analysis.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - actions: Perform image analysis",
|
|
"api_call": "POST /actions/analyzeImage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Perform different types of image analysis.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - document Jobs > {document Job Id}: Get details of a batch document job",
|
|
"api_call": "GET /documentJobs/{documentJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"documentJobId": "[REQUIRED] string: (Required) Document job id."
|
|
},
|
|
"functionality": "Get details of a batch document job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - document Jobs > {document Job Id}: Cancel a batch document job.",
|
|
"api_call": "POST /documentJobs/{documentJobId}/actions/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"documentJobId": "[REQUIRED] string: (Required) Document job id."
|
|
},
|
|
"functionality": "Cancel a batch document job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - document Jobs: Create a batch document analysis job",
|
|
"api_call": "POST /documentJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a batch document analysis job\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - image Jobs > {image Job Id}: Get details of a batch image job.",
|
|
"api_call": "GET /imageJobs/{imageJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"imageJobId": "[REQUIRED] string: (Required) Image job id."
|
|
},
|
|
"functionality": "Get details of a batch image job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - image Jobs > {image Job Id}: Cancel a batch image job.",
|
|
"api_call": "POST /imageJobs/{imageJobId}/actions/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"imageJobId": "[REQUIRED] string: (Required) Image job id."
|
|
},
|
|
"functionality": "Cancel a batch image job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - image Jobs: Create a batch image analysis job",
|
|
"api_call": "POST /imageJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a batch image analysis job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - model Deployments > {model Id}: Get details of a model deployment",
|
|
"api_call": "GET /modelDeployments/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: Compartment id.",
|
|
"modelId": "[REQUIRED] string: (Required) Model id."
|
|
},
|
|
"functionality": "Get details of a model deployment such as life cycle state and life cycle details.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - model Deployments > {model Id}: Delete a model deployment",
|
|
"api_call": "DELETE /modelDeployments/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: Compartment id.",
|
|
"modelId": "[REQUIRED] string: (Required) Model id."
|
|
},
|
|
"functionality": "Delete a model deployment with model id.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - model Deployments: Create a model deployment",
|
|
"api_call": "POST /modelDeployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a model deployment with model id and model type.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id} > actions: Moves a model into a different compartment",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Moves a model from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id} > actions: Get Model metadata",
|
|
"api_call": "GET /models/{modelId}/actions/getMetadata",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Gets metadata(compartmentId) of a model by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id}: Get model",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Gets a model by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id}: Update metadata about the model",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Updates model metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id}: Delete a model",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Deletes a model by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models: Gets a list of all models in a compartment",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
|
|
},
|
|
"functionality": "Returns a list of models in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models: Creates a new model",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Get project",
|
|
"api_call": "GET /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Gets a project by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Update metadata about the project",
|
|
"api_call": "PUT /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Updates project metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Delete a project",
|
|
"api_call": "DELETE /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Deletes a project by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Moves a project into a different compartment",
|
|
"api_call": "POST /projects/{projectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Moves a project from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects: Gets a list of all projects in a compartment",
|
|
"api_call": "GET /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
|
|
},
|
|
"functionality": "Returns a list of projects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects: Creates a new project",
|
|
"api_call": "POST /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new project.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Get work request status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Cancel the work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancel work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id} > actions: CancelJobRun",
|
|
"api_call": "POST /jobRuns/{jobRunId}/actions/cancelJobRun",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Cancels an IN_PROGRESS job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id} > actions: ChangeJobRunCompartment",
|
|
"api_call": "POST /jobRuns/{jobRunId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Changes a job run's compartment",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id}: DeleteJobRun",
|
|
"api_call": "DELETE /jobRuns/{jobRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Deletes a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id}: GetJobRun",
|
|
"api_call": "GET /jobRuns/{jobRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Gets a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs > {job Run Id}: UpdateJobRun",
|
|
"api_call": "PUT /jobRuns/{jobRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobRunId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job run."
|
|
},
|
|
"functionality": "Updates a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs: ListJobRuns",
|
|
"api_call": "GET /jobRuns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"jobId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n"
|
|
},
|
|
"functionality": "List out job runs.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - job Runs: CreateJobRun",
|
|
"api_call": "POST /jobRuns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a job run.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id} > artifact > content: GetJobArtifactContent",
|
|
"api_call": "GET /jobs/{jobId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"range": "string: Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7232#section-2.1), section 2.1.\nNote that only a single range of bytes is supported.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Downloads job artifact content for specified job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id} > artifact > content: HeadJobArtifact",
|
|
"api_call": "HEAD /jobs/{jobId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Gets job artifact metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id} > artifact: CreateJobArtifact",
|
|
"api_call": "POST /jobs/{jobId}/artifact",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"content-disposition": "string: This header allows you to specify a filename during upload. This file name is used to dispose of the file contents\nwhile downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file\nname when downloading.\nExample: `{\"Content-Disposition\": \"attachment\"\n \"filename\"=\"model.tar.gz\"\n \"Content-Length\": \"2347\"\n \"Content-Type\": \"application/gzip\"}`\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Uploads a job artifact.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: DeleteJob",
|
|
"api_call": "DELETE /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"deleteRelatedJobRuns": "boolean: Delete all JobRuns associated with this job.",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Deletes a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: GetJob",
|
|
"api_call": "GET /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Gets a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: UpdateJob",
|
|
"api_call": "PUT /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Updates a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs > {job Id}: ChangeJobCompartment",
|
|
"api_call": "POST /jobs/{jobId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Changes a job's compartment",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs: ListJobs",
|
|
"api_call": "GET /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\n state for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "List jobs in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - jobs: CreateJob",
|
|
"api_call": "POST /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id} > actions: Activates the model deployment.",
|
|
"api_call": "POST /modelDeployments/{modelDeploymentId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Activates the model deployment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id} > actions: Moves a model deployment into a different compartment.",
|
|
"api_call": "POST /modelDeployments/{modelDeploymentId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Moves a model deployment into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id} > actions: Deactivates the model deployment.",
|
|
"api_call": "POST /modelDeployments/{modelDeploymentId}/actions/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Deactivates the model deployment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id}: Deletes the model deployment.",
|
|
"api_call": "DELETE /modelDeployments/{modelDeploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Deletes the specified model deployment. Any unsaved work in this model deployment is lost.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id}: Gets the model deployment.",
|
|
"api_call": "GET /modelDeployments/{modelDeploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Retrieves the model deployment for the specified `modelDeploymentId`.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments > {model Deployment Id}: Updates the model deployment.",
|
|
"api_call": "PUT /modelDeployments/{modelDeploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelDeploymentId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model deployment."
|
|
},
|
|
"functionality": "Updates the properties of a model deployment. Some of the properties of `modelDeploymentConfigurationDetails` or `CategoryLogDetails` can also be updated with zero down time\nwhen the model deployment\u2019s lifecycle state is ACTIVE or NEEDS_ATTENTION i.e `instanceShapeName`, `instanceCount` and `modelId`, separately `loadBalancerShape` or `CategoryLogDetails`\ncan also be updated independently. All of the fields can be updated when the deployment is in the INACTIVE lifecycle state. Changes will take effect the next time the model\ndeployment is activated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments: Lists the model deployments.",
|
|
"api_call": "GET /modelDeployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists all model deployments in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - model Deployments: Creates a new model deployment.",
|
|
"api_call": "POST /modelDeployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new model deployment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > actions: ActivateModel",
|
|
"api_call": "POST /models/{modelId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Activates the model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > actions: ChangeModelCompartment",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Moves a model resource into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > actions: DeactivateModel",
|
|
"api_call": "POST /models/{modelId}/actions/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Deactivates the model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > artifact > content: GetModelArtifactContent",
|
|
"api_call": "GET /models/{modelId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"range": "string: Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7232#section-2.1), section 2.1.\nNote that only a single range of bytes is supported.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Downloads model artifact content for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > artifact > content: HeadModelArtifact",
|
|
"api_call": "HEAD /models/{modelId}/artifact/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Gets model artifact metadata for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > artifact: CreateModelArtifact",
|
|
"api_call": "POST /models/{modelId}/artifact",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"content-disposition": "string: This header allows you to specify a filename during upload. This file name is used to dispose of the file contents\nwhile downloading the file. If this optional field is not populated in the request, then the OCID of the model is used for the file\nname when downloading.\nExample: `{\"Content-Disposition\": \"attachment\"\n \"filename\"=\"model.tar.gz\"\n \"Content-Length\": \"2347\"\n \"Content-Type\": \"application/gzip\"}`\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Creates model artifact for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > provenance: GetModelProvenance",
|
|
"api_call": "GET /models/{modelId}/provenance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Gets provenance information for specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > provenance: CreateModelProvenance",
|
|
"api_call": "POST /models/{modelId}/provenance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Creates provenance information for the specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id} > provenance: UpdateModelProvenance",
|
|
"api_call": "PUT /models/{modelId}/provenance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Updates the provenance information for the specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id}: DeleteModel",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Deletes the specified model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id}: GetModel",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Gets the specified model's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models > {model Id}: UpdateModel",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"modelId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model."
|
|
},
|
|
"functionality": "Updates the properties of a model. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models: ListModels",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. All other fields default to ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists models in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - models: CreateModel",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new model.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id} > actions: ActivateNotebookSession",
|
|
"api_call": "POST /notebookSessions/{notebookSessionId}/actions/activate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Activates the notebook session.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id} > actions: ChangeNotebookSessionCompartment",
|
|
"api_call": "POST /notebookSessions/{notebookSessionId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Moves a notebook session resource into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id} > actions: DeactivateNotebookSession",
|
|
"api_call": "POST /notebookSessions/{notebookSessionId}/actions/deactivate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Deactivates the notebook session.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id}: DeleteNotebookSession",
|
|
"api_call": "DELETE /notebookSessions/{notebookSessionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Deletes the specified notebook session. Any unsaved work in this notebook session are lost.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id}: GetNotebookSession",
|
|
"api_call": "GET /notebookSessions/{notebookSessionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Gets the specified notebook session's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions > {notebook Session Id}: UpdateNotebookSession",
|
|
"api_call": "PUT /notebookSessions/{notebookSessionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"notebookSessionId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the notebook session."
|
|
},
|
|
"functionality": "Updates the properties of a notebook session. You can update the `displayName`, `freeformTags`, and `definedTags` properties.\nWhen the notebook session is in the INACTIVE lifecycle state, you can update `notebookSessionConfigurationDetails` and change `shape`, `subnetId`, and `blockStorageSizeInGBs`.\nChanges to the `notebookSessionConfigurationDetails` take effect the next time the `ActivateNotebookSession` action is invoked on the notebook session resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions: ListNotebookSessions",
|
|
"api_call": "GET /notebookSessions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"projectId": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project.",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the notebook sessions in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - notebook Sessions: CreateNotebookSession",
|
|
"api_call": "POST /notebookSessions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new notebook session.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: DeleteProject",
|
|
"api_call": "DELETE /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Deletes the specified project. This operation fails unless all associated resources (notebook sessions or models) are in a DELETED state. You must delete all associated resources before deleting a project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: GetProject",
|
|
"api_call": "GET /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Gets the specified project's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: UpdateProject",
|
|
"api_call": "PUT /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Updates the properties of a project. You can update the `displayName`, `description`, `freeformTags`, and `definedTags` properties.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects > {project Id}: ChangeProjectCompartment",
|
|
"api_call": "POST /projects/{projectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"projectId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project."
|
|
},
|
|
"functionality": "Moves a project resource into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects: ListProjects",
|
|
"api_call": "GET /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"displayName": "string: <b>Filter</b> results by its user-friendly name.",
|
|
"lifecycleState": "string: <b>Filter</b> results by the specified lifecycle state. Must be a valid\nstate for the resource type.\n",
|
|
"createdBy": "string: <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the resource.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field.\nBy default, when you sort by `timeCreated`, the results are shown\nin descending order. When you sort by `displayName`, the results are\nshown in ascending order. Sort order for the `displayName` field is case sensitive.\n"
|
|
},
|
|
"functionality": "Lists projects in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - projects: CreateProject",
|
|
"api_call": "POST /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"opc-retry-token": "string: 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.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new project.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: CancelWorkRequest",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource is updated or deleted only if the `etag` you\nprovide matches the resource's current `etag` value.\n",
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Cancels a work request that has not started.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: GetWorkRequest",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Gets the specified work request's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: ListWorkRequestErrors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Lists work request errors for the specified work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests > {work Request Id}: ListWorkRequestLogs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Lists work request logs for the specified work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - work Requests: ListWorkRequests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"id": "string: <b>Filter</b> results by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm). Must be an OCID of the correct type for the resource type.\n",
|
|
"operationType": "string: <b>Filter</b> results by the type of the operation associated with the work request.",
|
|
"status": "string: <b>Filter</b> results by work request status.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n",
|
|
"sortOrder": "string: Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).\n",
|
|
"sortBy": "string: Specifies the field to sort by. Accepts only one field. By default, when you sort by time fields, the results are shown in descending order. All other fields default to ascending order.\n"
|
|
},
|
|
"functionality": "Lists work requests in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: ListJobShapes",
|
|
"api_call": "GET /jobShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n"
|
|
},
|
|
"functionality": "List job shapes available in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: Lists the valid model deployment shapes.",
|
|
"api_call": "GET /modelDeploymentShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n"
|
|
},
|
|
"functionality": "Lists the valid model deployment shapes.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: ListNotebookSessionShapes",
|
|
"api_call": "GET /notebookSessionShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, then provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) <b>Filter</b> results by the [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page,\nor items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum.\nSee [List Pagination](https://docs.oracle.com/iaas/Content/General/Concepts/usingapi.htm#nine).\n\nExample: `500`\n"
|
|
},
|
|
"functionality": "Lists the valid notebook session shapes.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Data Science API - General: EXAMPLE Model Invoke",
|
|
"api_call": "POST /{data_science_model_deployment_ocid}/predict",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"x-content-sha256": "string",
|
|
"Content-Type": "string",
|
|
"Authorization": "string",
|
|
"Date": "string",
|
|
"data_science_model_deployment_ocid": "[REQUIRED] string"
|
|
},
|
|
"functionality": "",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id} > actions: Initiates cluster migration to use native VCN.",
|
|
"api_call": "POST /clusters/{clusterId}/actions/migrateToNativeVcn",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Initiates cluster migration to use native VCN.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id} > actions: Update cluster endpoint details.",
|
|
"api_call": "POST /clusters/{clusterId}/actions/updateEndpointConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Update the details of the cluster endpoint configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Delete a cluster.",
|
|
"api_call": "DELETE /clusters/{clusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Delete a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Get cluster details.",
|
|
"api_call": "GET /clusters/{clusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Get the details of a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Update cluster details.",
|
|
"api_call": "PUT /clusters/{clusterId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Update the details of a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Create the cluster kubeconfig.",
|
|
"api_call": "POST /clusters/{clusterId}/kubeconfig/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Create the Kubeconfig YAML for a cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters > {cluster Id}: Get details on a cluster's migration to native VCN.",
|
|
"api_call": "GET /clusters/{clusterId}/migrateToNativeVcnStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterId": "[REQUIRED] string: (Required) The OCID of the cluster."
|
|
},
|
|
"functionality": "Get details on a cluster's migration to native VCN.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters: List all cluster objects.",
|
|
"api_call": "GET /clusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum. For important details about how pagination works,\nsee [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The optional order in which to sort the results.",
|
|
"sortBy": "string: The optional field to sort the results by."
|
|
},
|
|
"functionality": "List all the cluster objects in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - clusters: Create a new cluster.",
|
|
"api_call": "POST /clusters",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token you supply to uniquely identify the request and provide idempotency if\nthe request is retried. Idempotency tokens expire after 24 hours.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools > {node Pool Id}: Delete a node pool.",
|
|
"api_call": "DELETE /nodePools/{nodePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"nodePoolId": "[REQUIRED] string: (Required) The OCID of the node pool."
|
|
},
|
|
"functionality": "Delete a node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools > {node Pool Id}: Get node pool details.",
|
|
"api_call": "GET /nodePools/{nodePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"nodePoolId": "[REQUIRED] string: (Required) The OCID of the node pool."
|
|
},
|
|
"functionality": "Get the details of a node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools > {node Pool Id}: Update node pool details.",
|
|
"api_call": "PUT /nodePools/{nodePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"nodePoolId": "[REQUIRED] string: (Required) The OCID of the node pool."
|
|
},
|
|
"functionality": "Update the details of a node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools: List all node pools.",
|
|
"api_call": "GET /nodePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"clusterId": "string: The OCID of the cluster.",
|
|
"name": "string: The name to filter on.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum. For important details about how pagination works,\nsee [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The optional order in which to sort the results.",
|
|
"sortBy": "string: The optional field to sort the results by."
|
|
},
|
|
"functionality": "List all the node pools in a compartment, and optionally filter by cluster.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - node Pools: Create a new node pool.",
|
|
"api_call": "POST /nodePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token you supply to uniquely identify the request and provide idempotency if\nthe request is retried. Idempotency tokens expire after 24 hours.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a new node pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Cancel a work request.",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Cancel a work request that has not started.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Get work request details.",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Get the details of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Get work request errors.",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Get the errors of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests > {work Request Id}: Get work request logs.",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The OCID of the work request."
|
|
},
|
|
"functionality": "Get the logs of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - work Requests: List all work requests.",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"clusterId": "string: The OCID of the cluster.",
|
|
"resourceId": "string: The OCID of the resource associated with a work request",
|
|
"resourceType": "string: Type of the resource associated with a work request",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated \"List\" call.\n1 is the minimum, 1000 is the maximum. For important details about how pagination works,\nsee [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The optional order in which to sort the results.",
|
|
"sortBy": "string: The optional field to sort the results by."
|
|
},
|
|
"functionality": "List all work requests in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - General: Get cluster options.",
|
|
"api_call": "GET /clusterOptions/{clusterOptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The OCID of the compartment.",
|
|
"clusterOptionId": "[REQUIRED] string: (Required) The id of the option set to retrieve. Use \"all\" get all options, or use a cluster ID to get options specific to the provided cluster."
|
|
},
|
|
"functionality": "Get options available for clusters.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Container Engine for Kubernetes API - General: Get node pool options.",
|
|
"api_call": "GET /nodePoolOptions/{nodePoolOptionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The OCID of the compartment.",
|
|
"nodePoolOptionId": "[REQUIRED] string: (Required) The id of the option set to retrieve. Use \"all\" get all options, or use a cluster ID to get options specific to the provided cluster."
|
|
},
|
|
"functionality": "Get options available for node pools.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - query: Execute a SQL query.",
|
|
"api_call": "POST /query",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Execute a SQL query.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - query: Prepare a SQL statement for use in a query with variable substitution.\n",
|
|
"api_call": "GET /query/prepare",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"statement": "string: (Required) A NoSQL SQL statement."
|
|
},
|
|
"functionality": "Prepare a SQL statement for use in a query with variable substitution.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - query: Check the syntax and return a brief summary of a SQL statement.",
|
|
"api_call": "GET /query/summarize",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"statement": "string: (Required) A NoSQL SQL statement."
|
|
},
|
|
"functionality": "Check the syntax and return a brief summary of a SQL statement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes > {indexName}: Delete an index.",
|
|
"api_call": "DELETE /tables/{tableNameOrId}/indexes/{indexName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"isIfExists": "boolean: Set as true to select \"if exists\" behavior.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID.",
|
|
"indexName": "[REQUIRED] string: (Required) The name of a table's index."
|
|
},
|
|
"functionality": "Delete an index from the table identified by tableNameOrId.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes > {indexName}: Get information about a single index.",
|
|
"api_call": "GET /tables/{tableNameOrId}/indexes/{indexName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID.",
|
|
"indexName": "[REQUIRED] string: (Required) The name of a table's index."
|
|
},
|
|
"functionality": "Get information about a single index.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes: Get a list of indexes on a table.",
|
|
"api_call": "GET /tables/{tableNameOrId}/indexes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"name": "string: A shell-globbing-style (*?[]) filter for names.",
|
|
"lifecycleState": "string: Filter list by the lifecycle state of the item.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: The page token representing the page at which to start\nretrieving results. This is usually retrieved from a previous\nlist call.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be\nprovided. Default order for timeCreated is descending. Default\norder for name is ascending. If no value is specified\ntimeCreated is default.\n",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get a list of indexes on a table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > indexes: Create a new index.",
|
|
"api_call": "POST /tables/{tableNameOrId}/indexes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried\nin case of a timeout or server error without risk of executing\nthat same action again. Retry tokens expire after 24 hours, but\ncan be invalidated before then due to conflicting\noperations. For example, if a resource has been deleted and\npurged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Create a new index on the table identified by tableNameOrId.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > rows: Delete a single row from the table, by primary key.",
|
|
"api_call": "DELETE /tables/{tableNameOrId}/rows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"key": "string: (Required) An array of strings, each of the format \"column-name:value\",\nrepresenting the primary key of the row.\n",
|
|
"isGetReturnRow": "boolean: If true, and the operation fails due to an option setting\n(ifVersion et al), then the existing row will be returned.\n",
|
|
"timeoutInMs": "integer: Timeout setting for this operation.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Delete a single row from the table, by primary key.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > rows: Get a single row from the table by primary key.",
|
|
"api_call": "GET /tables/{tableNameOrId}/rows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"key": "string: (Required) An array of strings, each of the format \"column-name:value\",\nrepresenting the primary key of the row.\n",
|
|
"consistency": "string: Consistency requirement for a read operation.",
|
|
"timeoutInMs": "integer: Timeout setting for this operation.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get a single row from the table by primary key.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId} > rows: Write a single row into the table.",
|
|
"api_call": "PUT /tables/{tableNameOrId}/rows",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Write a single row into the table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Delete a table by tableNameOrId.",
|
|
"api_call": "DELETE /tables/{tableNameOrId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"isIfExists": "boolean: Set as true to select \"if exists\" behavior.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Delete a table by tableNameOrId.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Get table info by identifier.",
|
|
"api_call": "GET /tables/{tableNameOrId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get table info by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Alter the table identified by tableNameOrId.",
|
|
"api_call": "PUT /tables/{tableNameOrId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Alter the table identified by tableNameOrId,\nchanging schema, limits, or tags\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Change a table's compartment.",
|
|
"api_call": "POST /tables/{tableNameOrId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried\nin case of a timeout or server error without risk of executing\nthat same action again. Retry tokens expire after 24 hours, but\ncan be invalidated before then due to conflicting\noperations. For example, if a resource has been deleted and\npurged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Change a table's compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables > {tableNameOrId}: Get table usage info.",
|
|
"api_call": "GET /tables/{tableNameOrId}/usage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of a table's compartment. When a table is identified\nby name, the compartmentId is often needed to provide\ncontext for interpreting the name.\n",
|
|
"timeStart": "number: The start time to use for the request. If no time range\nis set for this request, the most recent complete usage\nrecord is returned.\n",
|
|
"timeEnd": "number: The end time to use for the request.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"tableNameOrId": "[REQUIRED] string: (Required) A table name within the compartment, or a table OCID."
|
|
},
|
|
"functionality": "Get table usage info.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables: Get a list of tables in a compartment.",
|
|
"api_call": "GET /tables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"name": "string: A shell-globbing-style (*?[]) filter for names.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be\nprovided. Default order for timeCreated is descending. Default\norder for name is ascending. If no value is specified\ntimeCreated is default.\n",
|
|
"lifecycleState": "string: Filter list by the lifecycle state of the item."
|
|
},
|
|
"functionality": "Get a list of tables in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - tables: Create a new table.",
|
|
"api_call": "POST /tables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried\nin case of a timeout or server error without risk of executing\nthat same action again. Retry tokens expire after 24 hours, but\ncan be invalidated before then due to conflicting\noperations. For example, if a resource has been deleted and\npurged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a new table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: Cancel a work request operation with the given ID.",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "boolean: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancel a work request operation with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: Get the status of the work request with the given ID.",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Get the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: List work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests > {workRequestId}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: NoSQL Database API - workRequests: List the work requests in a compartment.",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of a table's compartment.",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "List the work requests in a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Gets the properties of the specified configuration source provider.",
|
|
"api_call": "GET /configurationSourceProviders/{configurationSourceProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Gets the properties of the specified configuration source provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Updates the properties of the specified configuration source provider.",
|
|
"api_call": "PUT /configurationSourceProviders/{configurationSourceProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Updates the properties of the specified configuration source provider.\nFor more information, see\n[To edit a configuration source provider](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingconfigurationsourceproviders.htm#EditConfigurationSourceProvider).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Deletes the specified configuration source provider.",
|
|
"api_call": "DELETE /configurationSourceProviders/{configurationSourceProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Deletes the specified configuration source provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Moves a ConfigurationSourceProvider into a different compartment. When provided, If-Match is checked against ETag values of the ConfigurationSourceProvider.",
|
|
"api_call": "POST /configurationSourceProviders/{configurationSourceProviderId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Moves a configuration source provider into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers: Lists configuration source providers.",
|
|
"api_call": "GET /configurationSourceProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"configurationSourceProviderId": "string: A filter to return only configuration source providers that match the provided [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list a resource by name.\nRequires `sortBy` set to `DISPLAYNAME`.\nAlternatively, when you know the resource OCID, use the related Get operation.\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"configSourceProviderType": "string: A filter to return only configuration source providers of the specified type (GitHub or GitLab).\n"
|
|
},
|
|
"functionality": "Lists configuration source providers according to the specified filter.\n- For `compartmentId`, lists all configuration source providers in the matching compartment.\n- For `configurationSourceProviderId`, lists the matching configuration source provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers: Creates a configuration source provider in the specified compartment.",
|
|
"api_call": "POST /configurationSourceProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a configuration source provider in the specified compartment.\nFor more information, see\n[To create a configuration source provider](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingconfigurationsourceproviders.htm#CreateConfigurationSourceProvider).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id} > logs: Gets log entries for a job",
|
|
"api_call": "GET /jobs/{jobId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.",
|
|
"type": "string: A filter that returns only logs of a specified type.\n",
|
|
"levelGreaterThanOrEqualTo": "string: A filter that returns only log entries that match a given severity level or greater.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"timestampGreaterThanOrEqualTo": "number: Time stamp specifying the lower time limit for which logs are returned in a query.\nFormat is defined by RFC3339.\nExample: `2020-01-01T12:00:00.000Z`\n",
|
|
"timestampLessThanOrEqualTo": "number: Time stamp specifying the upper time limit for which logs are returned in a query.\nFormat is defined by RFC3339.\nExample: `2020-02-01T12:00:00.000Z`\n"
|
|
},
|
|
"functionality": "Returns console log entries for the specified job in JSON format.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id} > logs: Gets the raw logs for a job.",
|
|
"api_call": "GET /jobs/{jobId}/logs/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns a raw log file for the specified job. The raw log file contains console log entries in text format. The maximum number of entries in a file is 100,000.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Get details of a specific job.",
|
|
"api_call": "GET /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the specified job along with the job details.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Update a Job.",
|
|
"api_call": "PUT /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Updates the specified job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Cancel a Job",
|
|
"api_call": "DELETE /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"isForced": "boolean: Indicates whether a forced cancellation is requested for the job while it was running.\nA forced cancellation can result in an incorrect state file.\nFor example, the state file might not reflect the exact state of the provisioned resources.\n",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Indicates the intention to cancel the specified job.\nCancellation of the job is not immediate, and may be delayed,\nor may not happen at all.\nYou can optionally choose forced cancellation by setting `isForced` to true.\nA forced cancellation can result in an incorrect state file.\nFor example, the state file might not reflect the exact state of the provisioned resources.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Gets job detailed log content.",
|
|
"api_call": "GET /jobs/{jobId}/detailedLogContent",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the Terraform detailed log content for the specified job in plain text. [Learn about Terraform detailed log.](https://www.terraform.io/docs/internals/debugging.html)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Get zipped Terraform configuration used for a specific job.",
|
|
"api_call": "GET /jobs/{jobId}/tfConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the Terraform configuration file for the specified job in .zip format.\nReturns an error if no zip file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Get Terraform state output from a specified job.",
|
|
"api_call": "GET /jobs/{jobId}/tfState",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the Terraform state for the specified job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs: List all jobs related to a stack or compartment. By default, the list is ordered by time created.\nYou can alter the ordering by using `SortByQueryParam` and `SortOrderQueryParam`.\n",
|
|
"api_call": "GET /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"stackId": "string: The stack [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) on which to filter.\n",
|
|
"id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) on which to query for jobs.\n",
|
|
"lifecycleState": "string: A filter that returns all resources that match the specified lifecycle state.\nThe state value is case-insensitive.\n\nAllowable values:\n- ACCEPTED\n- IN_PROGRESS\n- FAILED\n- SUCCEEDED\n- CANCELING\n- CANCELED\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list a resource by name.\nRequires `sortBy` set to `DISPLAYNAME`.\nAlternatively, when you know the resource OCID, use the related Get operation.\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "integer: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Returns a list of jobs in a stack or compartment, ordered by time created.\n\n- To list all jobs in a stack, provide the stack [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n- To list all jobs in a compartment, provide the compartment [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n- To return a specific job, provide the job [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs: Create a Job.",
|
|
"api_call": "POST /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id} > actions: Moves a Stack and it's associated Jobs into a different compartment. When provided, If-Match is checked against ETag values of the Stack.",
|
|
"api_call": "POST /stacks/{stackId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Moves a Stack and it's associated Jobs into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id} > actions: Checks drift status for the specified stack.\n",
|
|
"api_call": "POST /stacks/{stackId}/actions/detectDrift",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Checks drift status for the specified stack.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id} > actions: Lists drift status details for each resource defined in the specified stack.",
|
|
"api_call": "POST /stacks/{stackId}/actions/listResourceDriftDetails",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"workRequestId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.",
|
|
"resourceDriftStatus": "string: A filter that returns only resources that match the given drift status. The value is case-insensitive.\nAllowable values -\n - NOT_CHECKED\n - MODIFIED\n - IN_SYNC\n - DELETED\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Lists drift status details for each resource defined in the specified stack.\nThe drift status details for a given resource indicate differences, if any, between the actual state\nand the expected (defined) state for that resource.\nThe drift status details correspond to the specified work request (`workRequestId`).\nIf no work request is specified, then the drift status details correspond to the latest completed work request for the stack.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Gets a stack by ID.",
|
|
"api_call": "GET /stacks/{stackId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Gets a stack using the stack ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Updates the specified stack object.",
|
|
"api_call": "PUT /stacks/{stackId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Updates the specified stack object.\nUse `UpdateStack` when you update your Terraform configuration\nand want your changes to be reflected in the execution plan.\nFor more information, see\n[To update a stack](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingstacksandjobs.htm#UpdateStack) and\n[To edit a stack](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingstacksandjobs.htm#EditStack).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Deletes a stack",
|
|
"api_call": "DELETE /stacks/{stackId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Deletes the specified stack object.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Gets the stack's zipped Terraform configuration",
|
|
"api_call": "GET /stacks/{stackId}/tfConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Returns the Terraform configuration file in .zip format for the specified stack.\nReturns an error if no zip file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Get Terraform state of the specified stack.",
|
|
"api_call": "GET /stacks/{stackId}/tfState",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Returns the Terraform state for the specified stack.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks: Returns a stack or list of stacks.",
|
|
"api_call": "GET /stacks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Returns a list of stacks.\n- If called using the compartment ID, returns all stacks in the specified compartment.\n- If called using the stack ID, returns the specified stack.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks: Creates a Stack.",
|
|
"api_call": "POST /stacks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a stack in the specified compartment.\nYou can create a stack from a Terraform configuration.\nThe Terraform configuration can be directly uploaded or referenced from a source code control system.\nYou can also create a stack from an existing compartment.\nYou can also upload the Terraform configuration from an Object Storage bucket.\nFor more information, see\n[To create a stack](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingstacksandjobs.htm#createstack-all).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Gets the specified template.",
|
|
"api_call": "GET /templates/{templateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Gets the specified template.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Updates the specified template.",
|
|
"api_call": "PUT /templates/{templateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Updates the specified template.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Deletes the specified template.",
|
|
"api_call": "DELETE /templates/{templateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Deletes the specified template.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Moves a template into a different compartment. When provided, If-Match is checked against ETag values of the Template.",
|
|
"api_call": "POST /templates/{templateId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Moves a template into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Gets the template's logo file",
|
|
"api_call": "GET /templates/{templateId}/logo",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Returns the Terraform logo file in .logo format for the specified template.\nReturns an error if no logo file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Gets the template's zipped Terraform configuration",
|
|
"api_call": "GET /templates/{templateId}/tfConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Returns the Terraform configuration file in .zip format for the specified template.\nReturns an error if no zip file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates: Lists templates according to the specified filter.",
|
|
"api_call": "GET /templates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"templateCategoryId": "string: Unique identifier of the template category.\nPossible values are `0` (Quick Starts), `1` (Service), `2` (Architecture), and `3` (Private).\n",
|
|
"templateId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list a resource by name.\nRequires `sortBy` set to `DISPLAYNAME`.\nAlternatively, when you know the resource OCID, use the related Get operation.\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists templates according to the specified filter.\nThe attributes `compartmentId` and `templateCategoryId` are required unless `templateId` is specified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates: Creates a private template in the specified compartment.",
|
|
"api_call": "POST /templates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a private template in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests > {work Request Id}: Get Work Request",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Return the given work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests: Lists work requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"resourceId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the work requests in a given compartment or for a given resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - General: Lists supported Resource Discovery services.",
|
|
"api_call": "GET /resourceDiscoveryServices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n"
|
|
},
|
|
"functionality": "Returns a list of supported services for Resource Discovery. For reference on service names, see the [Terraform provider documentation](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - General: Lists template categories.",
|
|
"api_call": "GET /templateCategories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header"
|
|
},
|
|
"functionality": "Lists template categories.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - General: Lists supported Terraform versions.",
|
|
"api_call": "GET /terraformVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n"
|
|
},
|
|
"functionality": "Returns a list of supported Terraform versions for use with stacks.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > verify: Verifies signed data by using the given VerifyDataDetails resource.",
|
|
"api_call": "POST /20180608/verify",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Verifies a digital signature that was generated by the [Sign](https://docs.oracle.com/iaas/api/#/en/key/latest/SignedData/Sign) operation\nby using the public key of the same asymmetric key that was used to sign the data. If you want to validate the\ndigital signature outside of the service, you can do so by using the public key of the asymmetric key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > usage: Gets the specified vault's usage against service limits.",
|
|
"api_call": "GET /20180608/vaults/{vaultId}/usage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets the count of keys and key versions in the specified vault to calculate usage against service limits.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > scheduleDeletion: Schedules the deletion of a vault.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it\nthat are not already scheduled for deletion to `PENDING_DELETION` and then deletes them after the\nretention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won't\nchange. If any keys in the vault are scheduled to be deleted after the specified time of\ndeletion for the vault, the call is rejected with the error code 409.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > listReplicas: Lists the replicas for a vault",
|
|
"api_call": "GET /20180608/vaults/{vaultId}/actions/listReplicas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists the replicas for a vault\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > deleteReplica: Deletes a vault replica",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/deleteReplica",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Deletes a vault replica\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > createReplica: Creates a replica for the vault in another region in the same realm",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/createReplica",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Creates a replica for the vault in another region in the same realm\n\nThe API is a no-op if called for same region that a vault is already replicated to.\n409 if called on a vault that is already replicated to a different region. Users need to delete\nexisting replica first before calling it with a different region.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > changeCompartment: Moves a vault into a different compartment.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Moves a vault into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the resource.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > cancelDeletion: Cancels the scheduled deletion of a vault.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion\nrestores the vault and all keys in it to their respective states from before their\nscheduled deletion. All keys that were scheduled for deletion prior to vault\ndeletion retain their lifecycle state and time of deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > backup: Backs up a vault.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/backup",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later.\nYou can backup a vault whether or not it contains keys. This operation only backs up the\nmetadata of the vault, and does not include key metadata.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId}: Gets details about a vault.",
|
|
"api_call": "GET /20180608/vaults/{vaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets the specified vault's configuration information.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId}: Updates the properties of a vault.",
|
|
"api_call": "PUT /20180608/vaults/{vaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the properties of a vault. Specifically, you can update the\n`displayName`, `freeformTags`, and `definedTags` properties. Furthermore,\nthe vault must be in an ACTIVE or CREATING state to be updated.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > actions > restoreFromObjectStore: Restores a vault from an object storage location.",
|
|
"api_call": "POST /20180608/vaults/actions/restoreFromObjectStore",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Restores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object\nStorage. If a vault with the same OCID already exists, this operation returns\na response with a 409 HTTP status error code.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > actions > restoreFromFile: Restores a vault from an encrypted backup file.",
|
|
"api_call": "POST /20180608/vaults/actions/restoreFromFile",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"content-md5": "string: The base64-encoded MD5 hash value of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15.\nIf the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5\nhash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and\na response with 400 Unmatched Content MD5 error is returned, along with the message: \"The computed MD5 of the request body (ACTUAL_MD5)\ndoes not match the Content-MD5 header (HEADER_MD5).\"\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Restores a vault from an encrypted backup file. If a vault\nwith the same OCID already exists, this operation returns a response with a\n409 HTTP status error code.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults: Lists vaults in the compartment.",
|
|
"api_call": "GET /20180608/vaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
|
|
},
|
|
"functionality": "Lists the vaults in the specified compartment.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults: Creates a new vault.",
|
|
"api_call": "POST /20180608/vaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new vault. The type of vault you create determines key placement, pricing, and\navailable options. Options include storage isolation, a dedicated service endpoint instead\nof a shared service endpoint for API calls, and either a dedicated hardware security module\n(HSM) or a multitenant HSM.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > sign: Signs data by using the given SignDataDetails resource.",
|
|
"api_call": "POST /20180608/sign",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a digital signature for a message or message digest by using the private key of a public-private key pair,\nalso known as an asymmetric key. To verify the generated signature, you can use the [Verify](https://docs.oracle.com/iaas/api/#/en/key/latest/VerifiedData/Verify)\noperation. Or, if you want to validate the signature outside of the service, you can do so by using the public key of the same asymmetric key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > replicaOperations > {replicationId} > status: Gets the replication status of a replica operation",
|
|
"api_call": "GET /20180608/replicaOperations/{replicationId}/status",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"replicationId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "When a vault has a replica, each operation on the vault or its resources, such as\nkeys, is replicated and has an associated replicationId. Replication status provides\ndetails about whether the operation associated with the given replicationId has been\nsuccessfully applied across replicas.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > {keyVersionId} > actions > scheduleDeletion: Schedules the deletion of a key version.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string",
|
|
"keyVersionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified key version. This sets the lifecycle state of the key version\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > {keyVersionId} > actions > cancelDeletion: Cancels the scheduled deletion of a key version.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string",
|
|
"keyVersionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of the specified key version. Canceling\na scheduled deletion restores the key version to its lifecycle state from\nbefore its scheduled deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > {keyVersionId}: Gets details about a key version.",
|
|
"api_call": "GET /20180608/keys/{keyId}/keyVersions/{keyVersionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string",
|
|
"keyVersionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified key version.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > import: Imports the given wrapped key material and then rotate the key to begin using the new key version for the specified key.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions/import",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Imports AES key material to create a new key version and then rotate the key to begin using the new\nkey version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key\nbefore you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes.\nFurthermore, the key length must match the length of the specified key and what you specify as the length\nat the time of import. When importing an asymmetric key, only the private key must be wrapped in PKCS8 format \nwhile the corresponding public key is generated internally by KMS.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions: Lists all key versions for a key.",
|
|
"api_call": "GET /20180608/keys/{keyId}/keyVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"limit": "string: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"page": "string: The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists all [KeyVersion](https://docs.oracle.com/iaas/api/#/en/key/latest/KeyVersion/) resources for the specified\nmaster encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions: Creates a new key version resource and rotates the key to use it for encryption.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Generates a new [KeyVersion](https://docs.oracle.com/iaas/api/#/en/key/latest/KeyVersion/) resource that provides new cryptographic\nmaterial for a master encryption key. The key must be in an `ENABLED` state to be rotated.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > scheduleDeletion: Schedules the deletion of a key.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified key. This sets the lifecycle state of the key\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > enable: Enables a key so it can be used for cryptographic operations.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/enable",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Enables a master encryption key so it can be used for encryption, decryption, or\ngenerating new data encryption keys.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > disable: Disables a key so it cannot be used for cryptographic operations.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/disable",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Disables a master encryption key so it can no longer be used for encryption, decryption, or\ngenerating new data encryption keys.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > changeCompartment: Moves a key into a different compartment.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Moves a key into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the key.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > cancelDeletion: Cancels the scheduled deletion of a key.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of the specified key. Canceling\na scheduled deletion restores the key's lifecycle state to what\nit was before its scheduled deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > backup: Backs up the key and associated key metadata.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/backup",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore\nthe key later. The file also contains the metadata of the vault that the key belonged to.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId}: Gets details about a key.",
|
|
"api_call": "GET /20180608/keys/{keyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified master encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second for\na given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId}: Updates a key's properties.",
|
|
"api_call": "PUT /20180608/keys/{keyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the properties of a master encryption key. Specifically, you can update the\n`displayName`, `freeformTags`, and `definedTags` properties. Furthermore,\nthe key must be in an `ENABLED` or `CREATING` state to be updated.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > import: Imports the given wrapped AES key.",
|
|
"api_call": "POST /20180608/keys/import",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Imports AES and RSA keys to create a new key. The key material must be base64-encoded \nand wrapped by the vault's public RSA wrapping key before you can import it. \nKey Management supports both RSA and AES keys. The AES keys are symmetric keys \nof length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). \nFurthermore, the key length must match what you specify at the time of import. When importing an asymmetric key, \nonly private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > actions > restoreFromObjectStore: Restores a key to a vault from an object storage location.",
|
|
"api_call": "POST /20180608/keys/actions/restoreFromObjectStore",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Restores the specified key to the specified vault from an Oracle Cloud Infrastructure\nObject Storage location. If the vault doesn't exist, the operation returns a response with a\n404 HTTP status error code. You need to first restore the vault associated with the key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > actions > restoreFromFile: Restores a key to a vault from a file.",
|
|
"api_call": "POST /20180608/keys/actions/restoreFromFile",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"content-md5": "string: The base64-encoded MD5 hash value of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15.\nIf the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5\nhash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and\na response with 400 Unmatched Content MD5 error is returned, along with the message: \"The computed MD5 of the request body (ACTUAL_MD5)\ndoes not match the Content-MD5 header (HEADER_MD5).\"\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Restores the specified key to the specified vault, based on information in the backup file provided.\nIf the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You\nneed to first restore the vault associated with the key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys: Lists keys in the specified vault and compartment.",
|
|
"api_call": "GET /20180608/keys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
|
|
},
|
|
"functionality": "Lists the master encryption keys in the specified vault and compartment.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys: Creates a new key.",
|
|
"api_call": "POST /20180608/keys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new master encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total\nnumber of requests across all management write operations. Key Management might throttle this call\nto reject an otherwise valid request when the total rate of management write operations exceeds 10\nrequests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > generateDataEncryptionKey: GenerateDataEncryptionKey",
|
|
"api_call": "POST /20180608/generateDataEncryptionKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Generates a key that you can use to encrypt or decrypt data.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > exportKey: Exports a master encryption key.",
|
|
"api_call": "POST /20180608/exportKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Exports a specific version of a master encryption key according to the details of the request. For their protection,\nkeys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys\nstored on the server. For export, the key version is encrypted by an RSA public key that you provide.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > encrypt: Encrypt",
|
|
"api_call": "POST /20180608/encrypt",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Encrypts data using the given [EncryptDataDetails](https://docs.oracle.com/iaas/api/#/en/key/latest/datatypes/EncryptDataDetails) resource.\nPlaintext included in the example request is a base64-encoded value of a UTF-8 string.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > decrypt: Decrypt",
|
|
"api_call": "POST /20180608/decrypt",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Decrypts data using the given [DecryptDataDetails](https://docs.oracle.com/iaas/api/#/en/key/latest/datatypes/DecryptDataDetails) resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > wrappingKeys: Gets details about the RSA wrapping key associated with the vault.",
|
|
"api_call": "GET /20180608/wrappingKeys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and\nunwraps AES key material for import into Key Management.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Retrieves a rule",
|
|
"api_call": "GET /rules/{ruleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Retrieves a rule.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Updates a rule",
|
|
"api_call": "PUT /rules/{ruleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Updates a rule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Deletes a rule",
|
|
"api_call": "DELETE /rules/{ruleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Deletes a rule.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules > {rule Id}: Moves a rule into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"api_call": "POST /rules/{ruleId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ruleId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.\n"
|
|
},
|
|
"functionality": "Moves a rule into a different compartment within the same tenancy. For information about moving \nresources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules: Lists rules for this compartment.",
|
|
"api_call": "GET /rules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs.\n",
|
|
"limit": "integer: The maximum number of items to return. 1 is the minimum, 50 is the maximum.\nDefault: 10\n",
|
|
"lifecycleState": "string: A filter to return only rules that match the lifecycle state in this parameter.\n\nExample: `Creating`\n",
|
|
"sortBy": "string: Specifies the attribute with which to sort the rules.\n\nDefault: `timeCreated`\n\n* **TIME_CREATED:** Sorts by timeCreated.\n* **DISPLAY_NAME:** Sorts by displayName.\n* **ID:** Sorts by id.\n",
|
|
"sortOrder": "string: Specifies sort order.\n\n* **ASC:** Ascending sort order.\n* **DESC:** Descending sort order.\n"
|
|
},
|
|
"functionality": "Lists rules for this compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Events API - rules: Creates a new rule",
|
|
"api_call": "POST /rules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new rule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect dominant language over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectDominantLanguage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API returns the detected language and a related confidence score (between 0 and 1). It supports passing a batch of records.\n\n[List of supported languages.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch Detect entities over pre-deployed model",
|
|
"api_call": "POST /actions/batchDetectLanguageEntities",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts entities in text records. For each entity, its type/subtype and confidence score (between 0 and 1) is returned. It supports passing a batch of records.\n\n[List of supported entities.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#ner__sup-ner-entity)\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect keyPhrase over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectLanguageKeyPhrases",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text. It supports passing a batch of records.\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect sentiments over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectLanguageSentiments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"level": "string: Set this parameter for sentence and aspect level sentiment analysis.\nAllowed values are:\n - ASPECT\n - SENTENCE\n"
|
|
},
|
|
"functionality": "The API extracts aspect-based and sentence level sentiment in text records.\n\nFor aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned for each record. Similarly, for sentence-level sentiment analysis, the sentiment is returned at the sentence level.\n\nFor sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral and mixed).\n\nLearn more about sentiment analysis [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment).\n\nLimitations:\n - A batch may have up to 100 records.\n - A record may be up to 5000 characters long.\n - The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Batch detect text classification over pre-deployed model.",
|
|
"api_call": "POST /actions/batchDetectLanguageTextClassification",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.\n\nIt supports passing a batch of records.\n\nLearn more about text classification [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class).\n\nLimitations:\n- A batch may have up to 100 records.\n- A record may be up to 5000 characters long.\n- The total of characters to process in a request can be up to 20,000 characters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect dominant language over pre-deployed model.",
|
|
"api_call": "POST /actions/detectDominantLanguage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API returns the detected language and a related confidence score (between 0 and 1).\n\n[List of supported languages.](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#lang-detect)\n\nLimitations:\n- A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect entities over pre-deployed model",
|
|
"api_call": "POST /actions/detectLanguageEntities",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelVersion": "number: Named Entity Recognition model versions. By default user will get output from V2.1 implementation.",
|
|
"isPii": "boolean: If this parameter is set to true, you only get PII (Personally identifiable information) entities\nlike PhoneNumber, Email, Person, and so on. Default value is false.\n"
|
|
},
|
|
"functionality": "The API extracts entities in text records. For each entity, its type and confidence score (between 0 and 1) is returned.\n\nLimitations:\n- A text may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect keyPhrase over pre-deployed model.",
|
|
"api_call": "POST /actions/detectLanguageKeyPhrases",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts key-phrases in text records. For each key-phrase, a score (between 0 and 1) is returned that highlights the importance of the key-phrase in the context of the text.\n\nLimitations:\n- A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect sentiments over pre-deployed model.",
|
|
"api_call": "POST /actions/detectLanguageSentiments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API extracts aspect-based in text records.\n\nFor aspect-based sentiment analysis, a set of aspects and their respective sentiment is returned.\n\nFor sentiment analysis, confidence scores are provided for each of the classes (positive, negative, neutral).\n\nLearn more about sentiment analysis [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#sentiment).\n\nLimitations:\n - A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Language API - actions: Detect text classification over pre-deployed model.",
|
|
"api_call": "POST /actions/detectLanguageTextClassification",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "The API automatically classifies text into a set of pre-determined classes and sub-classes. A single class/subclass is returned for each record classified.\n\nLearn more about text classification [here](https://docs.oracle.com/iaas/language/using/pretrain-models.htm#text-class).\n\nLimitations:\n- A record may be up to 1000 characters long.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements > {acceptedAgreementId}: Removes an accepted terms of use agreement.",
|
|
"api_call": "DELETE /acceptedAgreements/{acceptedAgreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"signature": "string: Previously, the signature generated for the listing package terms of use agreement, but now deprecated and ignored.",
|
|
"acceptedAgreementId": "[REQUIRED] string: (Required) The unique identifier for the accepted terms of use agreement."
|
|
},
|
|
"functionality": "Removes a previously accepted terms of use agreement from the list of agreements that Marketplace checks\nbefore initiating a deployment. Listings in Marketplace that require acceptance of the specified terms\nof use can no longer be deployed, but existing deployments aren't affected.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements > {acceptedAgreementId}: Gets the details of a terms of use agreement.",
|
|
"api_call": "GET /acceptedAgreements/{acceptedAgreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"acceptedAgreementId": "[REQUIRED] string: (Required) The unique identifier for the accepted terms of use agreement."
|
|
},
|
|
"functionality": "Gets the details of a specific, previously accepted terms of use agreement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements > {acceptedAgreementId}: Updates an accepted terms of use agreement.",
|
|
"api_call": "PUT /acceptedAgreements/{acceptedAgreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"acceptedAgreementId": "[REQUIRED] string: (Required) The unique identifier for the accepted terms of use agreement."
|
|
},
|
|
"functionality": "Updates the display name or tags associated with a listing's previously accepted terms of use agreement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements: Gets the list of accepted terms of use agreements in the specified compartment.",
|
|
"api_call": "GET /acceptedAgreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"displayName": "string: The display name of the resource.",
|
|
"listingId": "string: The unique identifier for the listing.",
|
|
"packageVersion": "string: The version of the package. Package versions are unique within a listing.",
|
|
"acceptedAgreementId": "string: The unique identifier for the accepted terms of use agreement.",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMEACCEPTED` displays results in descending order by default. You can change your\npreference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call."
|
|
},
|
|
"functionality": "Lists the terms of use agreements that have been accepted in the specified compartment.\nYou can filter results by specifying query parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - acceptedAgreements: Accepts a terms of use agreement for a listing.",
|
|
"api_call": "POST /acceptedAgreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Accepts a terms of use agreement for a specific package version of a listing. You must accept all\nterms of use for a package before you can deploy the package.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages > {packageVersion} > agreements: Lists terms of use agreements for a package.",
|
|
"api_call": "GET /listings/{listingId}/packages/{packageVersion}/agreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing."
|
|
},
|
|
"functionality": "Returns the terms of use agreements that must be accepted before you can deploy the specified version of a package.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages > {packageVersion} > agreements: Gets a terms of use agreement for a package.",
|
|
"api_call": "GET /listings/{listingId}/packages/{packageVersion}/agreements/{agreementId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing.",
|
|
"agreementId": "[REQUIRED] string: (Required) The unique identifier for the agreement."
|
|
},
|
|
"functionality": "Returns a terms of use agreement for a package with a time-based signature that can be used to\naccept the agreement.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages > {packageVersion}: Get the details of a specific package version.",
|
|
"api_call": "GET /listings/{listingId}/packages/{packageVersion}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing."
|
|
},
|
|
"functionality": "Get the details of the specified version of a package, including information needed to launch the package.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId} > packages: Gets the list of packages for a listing.",
|
|
"api_call": "GET /listings/{listingId}/packages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"packageVersion": "string: The version of the package. Package versions are unique within a listing.",
|
|
"packageType": "string: A filter to return only packages that match the given package type exactly.\n",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing."
|
|
},
|
|
"functionality": "Gets the list of packages for a listing.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId}: Gets the details of a listing.",
|
|
"api_call": "GET /listings/{listingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing."
|
|
},
|
|
"functionality": "Gets detailed information about a listing, including the listing's name, version, description, and\nresources.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings > {listingId}: Gets tax implication that current tenant may be eligible while using specific listing.",
|
|
"api_call": "GET /listings/{listingId}/taxes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The unique identifier for the compartment.",
|
|
"listingId": "[REQUIRED] string: (Required) The unique identifier for the listing."
|
|
},
|
|
"functionality": "Returns list of all tax implications that current tenant may be liable to once they launch the listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - listings: Gets a list of listings.",
|
|
"api_call": "GET /listings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"pricing": "string: Name of the pricing type. If multiple pricing types are provided, then any listing with\none or more matching pricing models will be returned.\n",
|
|
"listingTypes": "string: The type of the listing.",
|
|
"compartmentId": "string: The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Gets a list of listings from Oracle Cloud Infrastructure Marketplace by searching keywords and\nfiltering according to listing attributes.\n\nIf you plan to launch an instance from an image listing, you must first subscribe to the listing. When\nyou launch the instance, you also need to provide the image ID of the listing resource version that you want.\n\nSubscribing to the listing requires you to first get a signature from the terms of use agreement for the\nlisting resource version. To get the signature, issue a [GetAppCatalogListingAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements) API call.\nThe [AppCatalogListingResourceVersionAgreements](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersionAgreements) object, including\nits signature, is returned in the response. With the signature for the terms of use agreement for the desired\nlisting resource version, create a subscription by issuing a\n[CreateAppCatalogSubscription](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription) API call.\n\nTo get the image ID to launch an instance, issue a [GetAppCatalogListingResourceVersion](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion) API call.\nLastly, to launch the instance, use the image ID of the listing resource version to issue a [LaunchInstance](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/Instance/LaunchInstance) API call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId} > packages: Lists the packages in a publication.",
|
|
"api_call": "GET /publications/{publicationId}/packages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"packageVersion": "string: The version of the package. Package versions are unique within a listing.",
|
|
"packageType": "string: A filter to return only packages that match the given package type exactly.\n",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call.",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Lists the packages in the specified publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId} > packages: Gets a package version of a specified publication.",
|
|
"api_call": "GET /publications/{publicationId}/packages/{packageVersion}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication.",
|
|
"packageVersion": "[REQUIRED] string: (Required) The version of the package. Package versions are unique within a listing."
|
|
},
|
|
"functionality": "Gets the details of a specific package version within a given publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Deletes a publication.",
|
|
"api_call": "DELETE /publications/{publicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Deletes a publication, which also removes the associated listing from anywhere it was published, such as Marketplace or Compute.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Gets a publication.",
|
|
"api_call": "GET /publications/{publicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Gets the details of the specified publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Updates an existing publication.",
|
|
"api_call": "PUT /publications/{publicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Updates the details of an existing publication.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications > {publicationId}: Changes the compartment of the publication.",
|
|
"api_call": "POST /publications/{publicationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to\nthe value of the etag from a previous GET or POST response for that resource. The resource will be updated or\ndeleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"publicationId": "[REQUIRED] string: (Required) The unique identifier for the publication."
|
|
},
|
|
"functionality": "Moves the specified publication from one compartment to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications: Lists all publications.",
|
|
"api_call": "GET /publications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"listingType": "string: (Required) The type of the listing.",
|
|
"sortBy": "string: The field to use to sort listed results. You can only specify one field to sort by.\n`TIMERELEASED` displays results in descending order by default.\nYou can change your preference by specifying a different sort order.\n",
|
|
"sortOrder": "string: The sort order to use, either `ASC` or `DESC`.",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n"
|
|
},
|
|
"functionality": "Lists the publications in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - publications: Creates a publication.",
|
|
"api_call": "POST /publications",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without\nrisk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations (for example, if a resource has been deleted and purged from the system,\nthen a retry of the original creation request might be rejected).\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a publication of the specified listing type with an optional default package.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Gets a list of listing categories.",
|
|
"api_call": "GET /categories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"compartmentId": "string: The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Gets the list of all the categories for listings published to Oracle Cloud Infrastructure Marketplace. Categories apply\nto the software product provided by the listing.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Get Tenant eligibility and other information for launching a PIC image",
|
|
"api_call": "GET /launchEligibility",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"imageId": "string: (Required) Image ID"
|
|
},
|
|
"functionality": "Returns Tenant eligibility and other information for launching a PIC image",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Gets a list of publishers.",
|
|
"api_call": "GET /publishers",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n",
|
|
"compartmentId": "string: The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Gets the list of all the publishers of listings available in Oracle Cloud Infrastructure Marketplace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Lists available reports.",
|
|
"api_call": "GET /reportTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment.",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call."
|
|
},
|
|
"functionality": "Lists available types of reports for the compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Lists reports.",
|
|
"api_call": "GET /reports",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"reportType": "string: (Required) The type of the report.",
|
|
"date": "number: (Required) Date, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The service only interprets the year, month, and day parts in the input value, and ignores the hour, minute, and second parts.\n",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Lists reports in the compartment that match the specified report type and date.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Finds Marketplace listings",
|
|
"api_call": "POST /searchListings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30.\n"
|
|
},
|
|
"functionality": "Queries all Marketplace Applications to find listings that match the specified criteria. To search \nfor a listing, you can use a free text or structured search.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Marketplace Service API - General: Get eligibilty of the tenancy to see third party paid listings",
|
|
"api_call": "GET /thirdPartyPaidListingEligibility",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,\nplease provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The unique identifier for the compartment."
|
|
},
|
|
"functionality": "Returns eligibility details of the tenancy to see and launch third party paid listings",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Logging Search API - General: Search logs.",
|
|
"api_call": "POST /search",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about\na particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return in a response.\n"
|
|
},
|
|
"functionality": "Submit a query to search logs.\n\nSee [Using the API](https://docs.oracle.com/iaas/Content/Logging/Concepts/using_the_api_searchlogs.htm) for SDK examples.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > actions: Moves a resource into a different compartment.",
|
|
"api_call": "POST /queues/{queueId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Moves a queue from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > actions: Deletes all messages present in the queue at the time of invocation.",
|
|
"api_call": "POST /queues/{queueId}/actions/purge",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Deletes all messages present in the queue at the time of invocation. Only one concurrent purge operation is supported for any given queue.\nHowever multiple concurrent purge operations are supported for different queues.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > actions: Deletes multiple messages from the queue.",
|
|
"api_call": "POST /20210201/queues/{queueId}/messages/actions/deleteMessages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Deletes multiple messages from the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > actions: Updates multiple messages in the queue.",
|
|
"api_call": "POST /20210201/queues/{queueId}/messages/actions/updateMessages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Updates multiple messages in the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > {message Receipt}: Deletes a message from the queue.",
|
|
"api_call": "DELETE /20210201/queues/{queueId}/messages/{messageReceipt}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier.",
|
|
"messageReceipt": "[REQUIRED] string: (Required) The receipt of the message retrieved from a GetMessages call."
|
|
},
|
|
"functionality": "Deletes the message represented by the receipt from the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > {message Receipt}: Updates the visibility of a message to extend (or reduce) it.",
|
|
"api_call": "PUT /20210201/queues/{queueId}/messages/{messageReceipt}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier.",
|
|
"messageReceipt": "[REQUIRED] string: (Required) The receipt of the message retrieved from a GetMessages call."
|
|
},
|
|
"functionality": "Updates the visibility of the message represented by the receipt.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages: Consumes message from the queue.",
|
|
"api_call": "GET /20210201/queues/{queueId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Consumes messages from the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages: Puts messages in the queue.",
|
|
"api_call": "POST /20210201/queues/{queueId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Puts messages into the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Delete a provisioned Queue",
|
|
"api_call": "DELETE /queues/{queueId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Deletes a queue resource by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Get Queue",
|
|
"api_call": "GET /queues/{queueId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Gets a queue by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Update the Queue identified by the id",
|
|
"api_call": "PUT /queues/{queueId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Updates the specified queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Gets the statistics for the queue and its dead letter queue.",
|
|
"api_call": "GET /20210201/queues/{queueId}/stats",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Gets the statistics for the queue and its dead letter queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues: Gets a list of all Queues in a compartment",
|
|
"api_call": "GET /queues",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Returns a list of queues.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues: Creates a new Queue",
|
|
"api_call": "POST /queues",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new queue.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests > {work Request Id}: GET Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine)."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables > {custom Table Id}: Returns saved custom table.",
|
|
"api_call": "GET /customTables/{customTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"customTableId": "[REQUIRED] string: (Required) The custom table unique OCID."
|
|
},
|
|
"functionality": "Returns the saved custom table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables > {custom Table Id}: Update a custom table.",
|
|
"api_call": "PUT /customTables/{customTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"customTableId": "[REQUIRED] string: (Required) The custom table unique OCID."
|
|
},
|
|
"functionality": "Update a saved custom table by table ID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables > {custom Table Id}: Delete a custom table.",
|
|
"api_call": "DELETE /customTables/{customTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"customTableId": "[REQUIRED] string: (Required) The custom table unique OCID."
|
|
},
|
|
"functionality": "Delete a saved custom table by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables: Returns saved custom tables.",
|
|
"api_call": "GET /customTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"compartmentId": "string: (Required) The compartment ID in which to list resources.",
|
|
"savedReportId": "string: (Required) The saved report ID in which to list resources.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is displayName.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the saved custom table list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables: Create a custom table.",
|
|
"api_call": "POST /customTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error, without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Returns the created custom table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries > {query Id}: Returns saved query.",
|
|
"api_call": "GET /queries/{queryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"queryId": "[REQUIRED] string: (Required) The query unique OCID."
|
|
},
|
|
"functionality": "Returns the saved query.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries > {query Id}: Update a query.",
|
|
"api_call": "PUT /queries/{queryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queryId": "[REQUIRED] string: (Required) The query unique OCID."
|
|
},
|
|
"functionality": "Update a saved query by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries > {query Id}: Delete a query.",
|
|
"api_call": "DELETE /queries/{queryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"queryId": "[REQUIRED] string: (Required) The query unique OCID."
|
|
},
|
|
"functionality": "Delete a saved query by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries: Returns saved queries and UI properties.",
|
|
"api_call": "GET /queries",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"compartmentId": "string: (Required) The compartment ID in which to list resources.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is displayName.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the saved query list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries: Create a query.",
|
|
"api_call": "POST /queries",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error, without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Returns the created query.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - scheduled Runs: Returns schedule history list.",
|
|
"api_call": "GET /scheduledRuns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"scheduleId": "string: (Required) The schedule unique ID.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is timeCreated.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the schedule history list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - scheduled Runs: Returns saved schedule run.",
|
|
"api_call": "GET /scheduledRuns/{scheduledRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"scheduledRunId": "[REQUIRED] string: (Required) The scheduled run unique OCID."
|
|
},
|
|
"functionality": "Returns the saved schedule run.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules > {schedule Id}: Returns saved schedule.",
|
|
"api_call": "GET /schedules/{scheduleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"scheduleId": "[REQUIRED] string: (Required) The schedule unique OCID."
|
|
},
|
|
"functionality": "Returns the saved schedule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules > {schedule Id}: Update schedule.",
|
|
"api_call": "PUT /schedules/{scheduleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"scheduleId": "[REQUIRED] string: (Required) The schedule unique OCID."
|
|
},
|
|
"functionality": "Update a saved schedule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules > {schedule Id}: Delete a schedule.",
|
|
"api_call": "DELETE /schedules/{scheduleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"scheduleId": "[REQUIRED] string: (Required) The schedule unique OCID."
|
|
},
|
|
"functionality": "Delete a saved scheduled report by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules: Returns the saved schedule list.",
|
|
"api_call": "GET /schedules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The compartment ID in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is timeCreated.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the saved schedule list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules: Create a schedule.",
|
|
"api_call": "POST /schedules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error, without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Returns the created schedule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - General: Returns configurations.",
|
|
"api_call": "GET /configuration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"tenantId": "string: (Required) tenant id"
|
|
},
|
|
"functionality": "Returns the configurations list for the UI drop-down list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - General: Returns usage for the given account.",
|
|
"api_call": "POST /usage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Returns usage for the given account.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Retrieval API - secretbundles > {secretId} > versions: Lists all secret bundle versions.",
|
|
"api_call": "GET /secretbundles/{secretId}/versions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#List_Pagination).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call. For information about\npagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#List_Pagination).\n",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `VERSION_NUMBER` is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists all secret bundle versions for the specified secret.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Retrieval API - secretbundles > {secretId}: Gets a secret bundle.",
|
|
"api_call": "GET /secretbundles/{secretId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.",
|
|
"Accept": "string",
|
|
"versionNumber": "integer: The version number of the secret.",
|
|
"secretVersionName": "string: The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.)",
|
|
"stage": "string: The rotation state of the secret version.",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets a secret bundle that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter.\nIf none of these parameters are provided, the bundle for the secret version marked as `CURRENT` will be returned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Retrieval API - secretbundles > actions > getByName: Gets a secret bundle by secret name and vault ID.",
|
|
"api_call": "POST /secretbundles/actions/getByName",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.",
|
|
"Accept": "string",
|
|
"secretName": "string: (Required) A user-friendly name for the secret. Secret names are unique within a vault. Secret names are case-sensitive.",
|
|
"vaultId": "string: (Required) The OCID of the vault that contains the secret.",
|
|
"versionNumber": "integer: The version number of the secret.",
|
|
"secretVersionName": "string: The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.)",
|
|
"stage": "string: The rotation state of the secret version."
|
|
},
|
|
"functionality": "Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter.\nIf none of these parameters are provided, the bundle for the secret version marked as `CURRENT` is returned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - Model - Instance: Gets information about the specified instance",
|
|
"api_call": "GET /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string",
|
|
"compartmentId": "string: (Required) The OCID of the Compartment",
|
|
"instanceId": "[REQUIRED] string: (Required) The OCID of the instance"
|
|
},
|
|
"functionality": "Gets information about the specified instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - Model - Instance: Lists the instances",
|
|
"api_call": "GET /instances/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string",
|
|
"compartmentId": "string: (Required) The OCID of the Compartment"
|
|
},
|
|
"functionality": "Lists the instances in the specified compartment and the specified availability domain. You can filter the results by specifying an instance name (the list will include all the identically-named instances in the compartment).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions > reencrypt: Re-encrypt Bucket Data Encryption Key",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/reencrypt",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Re-encrypts the unique data encryption key that encrypts each object written to the bucket by using the most recent \nversion of the master encryption key assigned to the bucket. (All data encryption keys are encrypted by a master \nencryption key. Master encryption keys are assigned to buckets and managed by Oracle by default, but you can assign \na key that you created and control through the Oracle Cloud Infrastructure Key Management service.) The kmsKeyId property \nof the bucket determines which master encryption key is assigned to the bucket. If you assigned a different Key Management \nmaster encryption key to the bucket, you can call this API to re-encrypt all data encryption keys with the newly \nassigned key. Similarly, you might want to re-encrypt all data encryption keys if the assigned key has been rotated to \na new key version since objects were last added to the bucket. If you call this API and there is no kmsKeyId associated \nwith the bucket, the call will fail.\n\nCalling this API starts a work request task to re-encrypt the data encryption key of all objects in the bucket. Only \nobjects created before the time of the API call will be re-encrypted. The call can take a long time, depending on how many \nobjects are in the bucket and how big they are. This API returns a work request ID that you can use to retrieve the status \nof the work request task.\nAll the versions of objects will be re-encrypted whether versioning is enabled or suspended at the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions > reencrypt: Re-encrypt the data encryption keys associated with an object",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/reencrypt/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"versionId": "string: VersionId used to identify a particular version of the object",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Re-encrypts the data encryption keys that encrypt the object and its chunks. By default, when you create a bucket, the Object Storage\nservice manages the master encryption key used to encrypt each object's data encryption keys. The encryption mechanism that you specify for\nthe bucket applies to the objects it contains.\n\nYou can alternatively employ one of these encryption strategies for an object:\n\n- You can assign a key that you created and control through the Oracle Cloud Infrastructure Vault service.\n\n- You can encrypt an object using your own encryption key. The key you supply is known as a customer-provided encryption key (SSE-C).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Creates a copy object request.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/copyObject",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-source-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm to use to decrypt the source\nobject. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-source-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to decrypt\nthe source object. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-source-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key used to\ndecrypt the source object. This value is used to check the integrity of the encryption key. For\nmore information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a request to copy an object within a region or to another region.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Stops the replication policy associated with a destination bucket.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/makeBucketWritable",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Stops replication to the destination bucket and removes the replication policy. When the replication\npolicy was created, this destination bucket became read-only except for new and changed objects replicated\nautomatically from the source bucket. MakeBucketWritable removes the replication policy. This bucket is no\nlonger the target for replication and is now writable, allowing users to make changes to bucket contents.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Rename Object",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/renameObject",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Rename an object in the given Object Storage namespace.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Restore Objects",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/restoreObjects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Restores one or more objects specified by the objectName parameter.\nBy default objects will be restored for 24 hours. Duration can be configured using the hours parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > actions: Move the object into a different storage tier",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/actions/updateObjectStorageTier",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Changes the storage tier of the object specified by the objectName parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > l: GET object lifecycle policy",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/l",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Gets the object lifecycle policy for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > l: Put object lifecycle policy.",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/l",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates or replaces the object lifecycle policy for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > l: Delete object lifecycle policy",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/l",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Deletes the object lifecycle policy for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: GET Object",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"range": "string: Optional byte range to fetch, as described in [RFC 7233](https://tools.ietf.org/html/rfc7233#section-2.1).\nNote that only a single range of bytes is supported.\n",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Gets the metadata and body of an object. \n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: PUT Object",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Expect": "string: A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent.\nIf no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body.\nThe only allowed value for this parameter is \"100-Continue\" (case-insensitive).\n",
|
|
"Content-Length": "integer: (Required) The content length of the body.",
|
|
"Content-MD5": "string: The optional base-64 header that defines the encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object\nStorage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the\nMD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error\nis returned with the message:\n\n\"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)\"\n",
|
|
"Content-Language": "string: The optional Content-Language header that defines the content language of the object to upload. Specifying\nvalues for this header has no effect on Object Storage behavior. Programs that read the object determine what\nto do based on the value provided. For example, you could use this header to identify and differentiate objects\nbased on a particular language.\n",
|
|
"Content-Encoding": "string: The optional Content-Encoding header that defines the content encodings that were applied to the object to\nupload. Specifying values for this header has no effect on Object Storage behavior. Programs that read the\nobject determine what to do based on the value provided. For example, you could use this header to determine\nwhat decoding mechanisms need to be applied to obtain the media-type specified by the Content-Type header of\nthe object.\n",
|
|
"Content-Disposition": "string: The optional Content-Disposition header that defines presentational information for the object to be\nreturned in GetObject and HeadObject responses. Specifying values for this header has no effect on Object\nStorage behavior. Programs that read the object determine what to do based on the value provided.\nFor example, you could use this header to let users download objects with custom filenames in a browser.\n",
|
|
"Cache-Control": "string: The optional Cache-Control header that defines the caching behavior value to be returned in GetObject and\nHeadObject responses. Specifying values for this header has no effect on Object Storage behavior. Programs\nthat read the object determine what to do based on the value provided.\nFor example, you could use this header to identify objects that require caching restrictions.\n",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"storage-tier": "string: The storage tier that the object should be stored in. If not specified, the object will be stored in\nthe same storage tier as the bucket.\n",
|
|
"opc-meta-*": "string: Optional user-defined metadata key and value.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Creates a new object or overwrites an existing object with the same name. The maximum object size allowed by\nPutObject is 50 GiB.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements. \n\nSee [Special Instructions for Object Storage PUT](https://docs.oracle.com/iaas/Content/API/Concepts/signingrequests.htm#ObjectStoragePut)\nfor request signature requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: DELETE Object",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Deletes an object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o > {object Name}: HEAD Object",
|
|
"api_call": "HEAD /n/{namespaceName}/b/{bucketName}/o/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Gets the user-defined metadata and entity tag (ETag) for an object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > o: List Objects",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/o",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists the objects in a bucket. By default, ListObjects returns object names only. See the `fields`\nparameter for other fields that you can optionally include in ListObjects response.\n\nListObjects returns at most 1000 objects. To paginate through more objects, use the returned 'nextStartWith'\nvalue with the 'start' parameter. To filter which objects ListObjects returns, use the 'start' and 'end'\nparameters.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p > {par Id}: GET Preauthenticated Request",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/p/{parId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"parId": "[REQUIRED] string: (Required) The unique identifier for the pre-authenticated request. This can be used to manage operations against\nthe pre-authenticated request, such as GET or DELETE.\n"
|
|
},
|
|
"functionality": "Gets the pre-authenticated request for the bucket.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p > {par Id}: DELETE Preauthenticated Request",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/p/{parId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"parId": "[REQUIRED] string: (Required) The unique identifier for the pre-authenticated request. This can be used to manage operations against\nthe pre-authenticated request, such as GET or DELETE.\n"
|
|
},
|
|
"functionality": "Deletes the pre-authenticated request for the bucket.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p: List Preauthenticated Requests",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/p/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists pre-authenticated requests for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > p: Create Preauthenticated Request",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/p/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a pre-authenticated request specific to the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies > {replication Id}: Get replication policy.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"replicationId": "[REQUIRED] string: (Required) The ID of the replication policy."
|
|
},
|
|
"functionality": "Get the replication policy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies > {replication Id}: Delete replication policy.",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/replicationPolicies/{replicationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"replicationId": "[REQUIRED] string: (Required) The ID of the replication policy."
|
|
},
|
|
"functionality": "Deletes the replication policy associated with the source bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies: List the replication policies associated with a bucket.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/replicationPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "List the replication policies associated with a bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > replication Policies: Create replication policy.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/replicationPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a replication policy for the specified bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules > {retention Rule Id}: Get the specified retention rule.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"retentionRuleId": "[REQUIRED] string: (Required) The ID of the retention rule."
|
|
},
|
|
"functionality": "Get the specified retention rule.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules > {retention Rule Id}: Update the specified retention rule.",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"retentionRuleId": "[REQUIRED] string: (Required) The ID of the retention rule."
|
|
},
|
|
"functionality": "Updates the specified retention rule. Rule changes take effect typically within 30 seconds.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules > {retention Rule Id}: Delete the specified retention rule.",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/retentionRules/{retentionRuleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"retentionRuleId": "[REQUIRED] string: (Required) The ID of the retention rule."
|
|
},
|
|
"functionality": "Deletes the specified rule. The deletion takes effect typically within 30 seconds.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules: List the retention rules for a bucket.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/retentionRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Accept": "string",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "List the retention rules for a bucket. The retention rules are sorted based on creation time,\nwith the most recently created retention rule returned first.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > retention Rules: Create a new retention rule.",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/retentionRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Creates a new retention rule in the specified bucket. The new rule will take effect typically within 30 seconds.\nNote that a maximum of 100 rules are supported on a bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: List Multipart Upload Parts",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\" call. For important\ndetails about how pagination works, see [List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Lists the parts of an in-progress multipart upload.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: Upload Multipart Object Part",
|
|
"api_call": "PUT /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"Expect": "string: A value of `100-continue` requests preliminary verification of the request method, path, and headers before the request body is sent.\nIf no error results from such verification, the server will send a 100 (Continue) interim response to indicate readiness for the request body.\nThe only allowed value for this parameter is \"100-Continue\" (case-insensitive).\n",
|
|
"Content-Length": "integer: (Required) The content length of the body.",
|
|
"Content-MD5": "string: The optional base-64 header that defines the encoded MD5 hash of the body. If the optional Content-MD5 header is present, Object\nStorage performs an integrity check on the body of the HTTP request by computing the MD5 hash for the body and comparing it to the\nMD5 hash supplied in the header. If the two hashes do not match, the object is rejected and an HTTP-400 Unmatched Content MD5 error\nis returned with the message:\n\n\"The computed MD5 of the request body (ACTUAL_MD5) does not match the Content-MD5 header (HEADER_MD5)\"\n",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"uploadPartNum": "integer: (Required) The part number that identifies the object part currently being uploaded.",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Uploads a single part of a multipart upload.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: Commit Multipart Upload",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Commits a multipart upload, which involves checking part numbers and entity tags (ETags) of the parts, to create an aggregate object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u > {object Name}: Abort Multipart Upload",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/u/{objectName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"uploadId": "string: (Required) The upload ID for a multipart upload.",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n",
|
|
"objectName": "[REQUIRED] string: (Required) The name of the object. Avoid entering confidential information.\nExample: `test/object1.log`\n"
|
|
},
|
|
"functionality": "Aborts an in-progress multipart upload and deletes all parts that have been uploaded.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u: List Multipart Uploads",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/u",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists all of the in-progress multipart uploads for the given bucket in the given Object Storage namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name} > u: Create Multipart Upload",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/u",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. The only valid value is '*', which indicates that the request should\nfail if the resource already exists.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"opc-sse-customer-algorithm": "string: The optional header that specifies \"AES256\" as the encryption algorithm. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key": "string: The optional header that specifies the base64-encoded 256-bit encryption key to use to encrypt or\ndecrypt the data. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-customer-key-sha256": "string: The optional header that specifies the base64-encoded SHA256 hash of the encryption key. This\nvalue is used to check the integrity of the encryption key. For more information, see\n[Using Your Own Keys for Server-Side Encryption](https://docs.oracle.com/iaas/Content/Object/Tasks/usingyourencryptionkeys.htm).\n",
|
|
"opc-sse-kms-key-id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a master encryption key used to call the Key\nManagement service to generate a data encryption key or to encrypt or decrypt a data encryption key.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Starts a new multipart upload to a specific object in the given bucket in the given namespace.\n\nSee [Object Names](https://docs.oracle.com/iaas/Content/Object/Tasks/managingobjects.htm#namerequirements)\nfor object naming requirements.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: GET Bucket",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"fields": "string: Bucket summary includes the 'namespace', 'name', 'compartmentId', 'createdBy', 'timeCreated',\nand 'etag' fields. This parameter can also include 'approximateCount' (approximate number of objects), 'approximateSize'\n(total approximate size in bytes of all objects) and 'autoTiering' (state of auto tiering on the bucket).\nFor example 'approximateCount,approximateSize,autoTiering'.\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Gets the current representation of the given bucket in the given Object Storage namespace.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: POST Bucket",
|
|
"api_call": "POST /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Performs a partial or full update of a bucket's user-defined metadata.\n\nUse UpdateBucket to move a bucket from one compartment to another within the same tenancy. Supply the compartmentID\nof the compartment that you want to move the bucket to. For more information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](https://docs.oracle.com/en-us/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: DELETE Bucket",
|
|
"api_call": "DELETE /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Deletes a bucket if the bucket is already empty. If the bucket is not empty, use\n[DeleteObject](#/en/objectstorage/20160918/methods/DeleteObject) first. In addition,\nyou cannot delete a bucket that has a multipart upload in progress or a pre-authenticated\nrequest associated with that bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: HEAD Bucket",
|
|
"api_call": "HEAD /n/{namespaceName}/b/{bucketName}/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: The entity tag (ETag) to match with the ETag of an existing resource. If the specified ETag matches the ETag of\nthe existing resource, GET and HEAD requests will return the resource and PUT and POST requests will upload\nthe resource.\n",
|
|
"if-none-match": "string: The entity tag (ETag) to avoid matching. Wildcards ('*') are not allowed. If the specified ETag does not\nmatch the ETag of the existing resource, the request returns the expected response. If the ETag matches\nthe ETag of the existing resource, the request returns an HTTP 304 status without a response body.\n",
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Efficiently checks to see if a bucket exists and gets the current entity tag (ETag) for the bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: List Object Versions",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/objectversions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "Lists the object versions in a bucket.\n\nListObjectVersions returns an ObjectVersionCollection containing at most 1000 object versions. To paginate through\nmore object versions, use the returned `opc-next-page` value with the `page` request parameter.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b > {bucket Name}: List the replication sources of a destination bucket.",
|
|
"api_call": "GET /n/{namespaceName}/b/{bucketName}/replicationSources",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request.",
|
|
"bucketName": "[REQUIRED] string: (Required) The name of the bucket. Avoid entering confidential information.\nExample: `my-new-bucket1`\n"
|
|
},
|
|
"functionality": "List the replication sources of a destination bucket.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b: List Buckets",
|
|
"api_call": "GET /n/{namespaceName}/b/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list buckets.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "Gets a list of all BucketSummary items in a compartment. A BucketSummary contains only summary fields for the bucket\nand does not contain fields like the user-defined metadata.\n\nListBuckets returns a BucketSummary containing at most 1000 buckets. To paginate through more buckets, use the returned\n`opc-next-page` value with the `page` request parameter.\n\nTo use this and other API operations, you must be authorized in an IAM policy. If you are not authorized,\ntalk to an administrator. If you are an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name} > b: Create Bucket",
|
|
"api_call": "POST /n/{namespaceName}/b/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "Creates a bucket in the given namespace with a bucket name and optional user-defined metadata. Avoid entering\nconfidential information in bucket names.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name}: GET Namespace Metadata",
|
|
"api_call": "GET /n/{namespaceName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "Gets the metadata for the Object Storage namespace, which contains defaultS3CompartmentId and\ndefaultSwiftCompartmentId.\n\nAny user with the OBJECTSTORAGE_NAMESPACE_READ permission will be able to see the current metadata. If you are\nnot authorized, talk to an administrator. If you are an administrator who needs to write policies\nto give users access, see\n[Getting Started with Policies](https://docs.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n > {namespace Name}: PUT Namespace",
|
|
"api_call": "PUT /n/{namespaceName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"namespaceName": "[REQUIRED] string: (Required) The Object Storage namespace used for the request."
|
|
},
|
|
"functionality": "By default, buckets created using the Amazon S3 Compatibility API or the Swift API are created in the root\ncompartment of the Oracle Cloud Infrastructure tenancy.\n\nYou can change the default Swift/Amazon S3 compartmentId designation to a different compartmentId. All\nsubsequent bucket creations will use the new default compartment, but no previously created\nbuckets will be modified. A user must have OBJECTSTORAGE_NAMESPACE_UPDATE permission to make changes to the default\ncompartments for Amazon S3 and Swift.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - n: GET Namespace Name",
|
|
"api_call": "GET /n/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Each Oracle Cloud Infrastructure tenant is assigned one unique and uneditable Object Storage namespace. The namespace\nis a system-generated string assigned during account creation. For some older tenancies, the namespace string may be\nthe tenancy name in all lower-case letters. You cannot edit a namespace.\n\nGetNamespace returns the name of the Object Storage namespace for the user making the request.\nIf an optional compartmentId query parameter is provided, GetNamespace returns the namespace name of the corresponding\ntenancy, provided the user has access to it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: GET Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request for the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: Cancel a work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancels a work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: List Work Request Errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Lists the errors of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests > {work Request Id}: List Work Request Logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Lists the logs of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Object Storage Service API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-client-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list buckets.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](https://docs.oracle.com/en-us/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id} > resource Versions > {resource Version}: GetAppCatalogListingResourceVersion",
|
|
"api_call": "GET /appCatalogListings/{listingId}/resourceVersions/{resourceVersion}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing.",
|
|
"resourceVersion": "[REQUIRED] string: (Required) Listing Resource Version."
|
|
},
|
|
"functionality": "Gets the specified listing resource version.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id} > resource Versions > {resource Version}: GetAppCatalogListingAgreements",
|
|
"api_call": "GET /appCatalogListings/{listingId}/resourceVersions/{resourceVersion}/agreements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing.",
|
|
"resourceVersion": "[REQUIRED] string: (Required) Listing Resource Version."
|
|
},
|
|
"functionality": "Retrieves the agreements for a particular resource version of a listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id} > resource Versions: ListAppCatalogListingResourceVersions",
|
|
"api_call": "GET /appCatalogListings/{listingId}/resourceVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing."
|
|
},
|
|
"functionality": "Gets all resource versions for a particular listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings > {listing Id}: GetAppCatalogListing",
|
|
"api_call": "GET /appCatalogListings/{listingId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "[REQUIRED] string: (Required) The OCID of the listing."
|
|
},
|
|
"functionality": "Gets the specified listing.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Listings: ListAppCatalogListings",
|
|
"api_call": "GET /appCatalogListings",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"publisherName": "string: A filter to return only the publisher that matches the given publisher name exactly.\n",
|
|
"publisherType": "string: A filter to return only publishers that match the given publisher type exactly. Valid types are OCI, ORACLE, TRUSTED, STANDARD.\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n"
|
|
},
|
|
"functionality": "Lists the published listings.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Subscriptions: DeleteAppCatalogSubscription",
|
|
"api_call": "DELETE /appCatalogSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"listingId": "string: (Required) The OCID of the listing.",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"resourceVersion": "string: (Required) Listing Resource Version."
|
|
},
|
|
"functionality": "Delete a subscription for a listing resource version for a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Subscriptions: ListAppCatalogSubscriptions",
|
|
"api_call": "GET /appCatalogSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"listingId": "string: A filter to return only the listings that matches the given listing id.\n"
|
|
},
|
|
"functionality": "Lists subscriptions for a compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - app Catalog Subscriptions: CreateAppCatalogSubscription",
|
|
"api_call": "POST /appCatalogSubscriptions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create a subscription for listing resource version for a compartment. It will take some time to propagate to all regions.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - block Volume Replicas: ListBlockVolumeReplicas",
|
|
"api_call": "GET /blockVolumeReplicas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the block volume replicas in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - block Volume Replicas: GetBlockVolumeReplica",
|
|
"api_call": "GET /blockVolumeReplicas/{blockVolumeReplicaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"blockVolumeReplicaId": "[REQUIRED] string: (Required) The OCID of the block volume replica."
|
|
},
|
|
"functionality": "Gets information for the specified block volume replica.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments > {boot Volume Attachment Id}: DetachBootVolume",
|
|
"api_call": "DELETE /bootVolumeAttachments/{bootVolumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the boot volume attachment."
|
|
},
|
|
"functionality": "Detaches a boot volume from an instance. You must specify the OCID of the boot volume attachment.\n\nThis is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily\nuntil the attachment is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments > {boot Volume Attachment Id}: GetBootVolumeAttachment",
|
|
"api_call": "GET /bootVolumeAttachments/{bootVolumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the boot volume attachment."
|
|
},
|
|
"functionality": "Gets information about the specified boot volume attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments: ListBootVolumeAttachments",
|
|
"api_call": "GET /bootVolumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"bootVolumeId": "string: The OCID of the boot volume."
|
|
},
|
|
"functionality": "Lists the boot volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, boot volume OCID, or both.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Attachments: AttachBootVolume",
|
|
"api_call": "POST /bootVolumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Attaches the specified boot volume to the specified instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id} > actions: ChangeBootVolumeBackupCompartment",
|
|
"api_call": "POST /bootVolumeBackups/{bootVolumeBackupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Moves a boot volume backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id} > actions: CreateBootVolumeBackupCopy",
|
|
"api_call": "POST /bootVolumeBackups/{bootVolumeBackupId}/actions/copy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Creates a boot volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id}: DeleteBootVolumeBackup",
|
|
"api_call": "DELETE /bootVolumeBackups/{bootVolumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Deletes a boot volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id}: GetBootVolumeBackup",
|
|
"api_call": "GET /bootVolumeBackups/{bootVolumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Gets information for the specified boot volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups > {boot Volume Backup Id}: UpdateBootVolumeBackup",
|
|
"api_call": "PUT /bootVolumeBackups/{bootVolumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeBackupId": "[REQUIRED] string: (Required) The OCID of the boot volume backup."
|
|
},
|
|
"functionality": "Updates the display name for the specified boot volume backup.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups: ListBootVolumeBackups",
|
|
"api_call": "GET /bootVolumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"bootVolumeId": "string: The OCID of the boot volume.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sourceBootVolumeBackupId": "string: A filter to return only resources that originated from the given source boot volume backup.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is\ncase-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the boot volume backups in the specified compartment. You can filter the results by boot volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Backups: CreateBootVolumeBackup",
|
|
"api_call": "POST /bootVolumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new boot volume backup of the specified boot volume. For general information about boot volume backups,\nsee [Overview of Boot Volume Backups](/iaas/Content/Block/Concepts/bootvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Replicas: ListBootVolumeReplicas",
|
|
"api_call": "GET /bootVolumeReplicas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the boot volume replicas in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volume Replicas: GetBootVolumeReplica",
|
|
"api_call": "GET /bootVolumeReplicas/{bootVolumeReplicaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeReplicaId": "[REQUIRED] string: (Required) The OCID of the boot volume replica."
|
|
},
|
|
"functionality": "Gets information for the specified boot volume replica.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id} > kms Key: DeleteBootVolumeKmsKey",
|
|
"api_call": "DELETE /bootVolumes/{bootVolumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Removes the specified boot volume's assigned Key Management encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id} > kms Key: GetBootVolumeKmsKey",
|
|
"api_call": "GET /bootVolumes/{bootVolumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Gets the Key Management encryption key assigned to the specified boot volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id} > kms Key: UpdateBootVolumeKmsKey",
|
|
"api_call": "PUT /bootVolumes/{bootVolumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Updates the specified volume with a new Key Management master encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: DeleteBootVolume",
|
|
"api_call": "DELETE /bootVolumes/{bootVolumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Deletes the specified boot volume. The volume cannot have an active connection to an instance.\nTo disconnect the boot volume from a connected instance, see\n[Disconnecting From a Boot Volume](/iaas/Content/Block/Tasks/deletingbootvolume.htm).\n**Warning:** All data on the boot volume will be permanently lost when the boot volume is deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: GetBootVolume",
|
|
"api_call": "GET /bootVolumes/{bootVolumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Gets information for the specified boot volume.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: UpdateBootVolume",
|
|
"api_call": "PUT /bootVolumes/{bootVolumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Updates the specified boot volume's display name, defined tags, and free-form tags.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes > {boot Volume Id}: ChangeBootVolumeCompartment",
|
|
"api_call": "POST /bootVolumes/{bootVolumeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"bootVolumeId": "[REQUIRED] string: (Required) The OCID of the boot volume."
|
|
},
|
|
"functionality": "Moves a boot volume into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes: ListBootVolumes",
|
|
"api_call": "GET /bootVolumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: (Required) The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"volumeGroupId": "string: The OCID of the volume group."
|
|
},
|
|
"functionality": "Lists the boot volumes in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - boot Volumes: CreateBootVolume",
|
|
"api_call": "POST /bootVolumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new boot volume in the specified compartment from an existing boot volume or a boot volume backup.\nFor general information about boot volumes, see [Boot Volumes](/iaas/Content/Block/Concepts/bootvolumes.htm).\nYou may optionally specify a *display name* for the volume, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: AdvertiseByoipRange",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/advertise",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud.\nThe `ByoipRange` resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: ChangeByoipRangeCompartment",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Moves a BYOIP CIDR block to a different compartment. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: ValidateByoipRange",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/validate",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already\nmodified the information for the BYOIP CIDR block with your Regional Internet Registry. See [To import a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id} > actions: WithdrawByoipRange",
|
|
"api_call": "POST /byoipRanges/{byoipRangeId}/actions/withdraw",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Withdraws BGP route advertisement for the BYOIP CIDR block.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: DeleteByoipRange",
|
|
"api_call": "DELETE /byoipRanges/{byoipRangeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Deletes the specified `ByoipRange` resource.\nThe resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED.\nIt must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail.\nYou must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nIf the `ByoipRange` resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: GetByoipRange",
|
|
"api_call": "GET /byoipRanges/{byoipRangeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Gets the `ByoipRange` resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: UpdateByoipRange",
|
|
"api_call": "PUT /byoipRanges/{byoipRangeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Updates the tags or display name associated to the specified BYOIP CIDR block.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges > {byoip Range Id}: ListByoipAllocatedRanges",
|
|
"api_call": "GET /byoipRanges/{byoipRangeId}/byoipAllocatedRanges",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"byoipRangeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block."
|
|
},
|
|
"functionality": "Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.\nEach `ByoipAllocatedRange` object also lists the IP pool where it is allocated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges: ListByoipRanges",
|
|
"api_call": "GET /byoipRanges",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Lists the `ByoipRange` resources in the specified compartment.\nYou can filter the list using query parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - byoip Ranges: CreateByoipRange",
|
|
"api_call": "POST /byoipRanges",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a subrange of the BYOIP CIDR block.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: TerminateClusterNetwork",
|
|
"api_call": "DELETE /clusterNetworks/{clusterNetworkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Terminates the specified cluster network.\n\nWhen you delete a cluster network, all of its resources are permanently deleted,\nincluding associated instances and instance pools.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: GetClusterNetwork",
|
|
"api_call": "GET /clusterNetworks/{clusterNetworkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Gets information about the specified cluster network.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: UpdateClusterNetwork",
|
|
"api_call": "PUT /clusterNetworks/{clusterNetworkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Updates the specified cluster network. The OCID of the cluster network remains the same.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: ChangeClusterNetworkCompartment",
|
|
"api_call": "POST /clusterNetworks/{clusterNetworkId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Moves a cluster network into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move a cluster network to a different compartment, associated resources such as the instances\nin the cluster network, boot volumes, and VNICs are not moved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks > {cluster Network Id}: ListClusterNetworkInstances",
|
|
"api_call": "GET /clusterNetworks/{clusterNetworkId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"clusterNetworkId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cluster network."
|
|
},
|
|
"functionality": "Lists the instances in the specified cluster network.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks: ListClusterNetworks",
|
|
"api_call": "GET /clusterNetworks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the cluster networks in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cluster Networks: CreateClusterNetwork",
|
|
"api_call": "POST /clusterNetworks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a cluster network. For more information about cluster networks, see\n[Managing Cluster Networks](/iaas/Content/Compute/Tasks/managingclusternetworks.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: DeleteComputeCapacityReservation",
|
|
"api_call": "DELETE /computeCapacityReservations/{capacityReservationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Deletes the specified compute capacity reservation.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: GetComputeCapacityReservation",
|
|
"api_call": "GET /computeCapacityReservations/{capacityReservationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Gets information about the specified compute capacity reservation.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: UpdateComputeCapacityReservation",
|
|
"api_call": "PUT /computeCapacityReservations/{capacityReservationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Updates the specified capacity reservation and its associated capacity configurations.\nFields that are not provided in the request will not be updated. Capacity configurations that are not included will be deleted. \nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: ChangeComputeCapacityReservationCompartment",
|
|
"api_call": "POST /computeCapacityReservations/{capacityReservationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Moves a compute capacity reservation into a different compartment. For information about\nmoving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations > {capacity Reservation Id}: ListComputeCapacityReservationInstances",
|
|
"api_call": "GET /computeCapacityReservations/{capacityReservationId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"capacityReservationId": "[REQUIRED] string: (Required) The OCID of the compute capacity reservation."
|
|
},
|
|
"functionality": "Lists the instances launched under a capacity reservation. You can filter results by specifying criteria.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations: ListComputeCapacityReservations",
|
|
"api_call": "GET /computeCapacityReservations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the compute capacity reservations that match the specified criteria and compartment.\n\nYou can limit the list by specifying a compute capacity reservation display name\n(the list will include all the identically-named compute capacity reservations in the compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Capacity Reservations: CreateComputeCapacityReservation",
|
|
"api_call": "POST /computeCapacityReservations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new compute capacity reservation in the specified compartment and availability domain.\nCompute capacity reservations let you reserve instances in a compartment.\nWhen you launch an instance using this reservation, you are assured that you have enough space for your instance,\nand you won't get out of capacity errors.\nFor more information, see [Reserved Capacity](/iaas/Content/Compute/Tasks/reserve-capacity.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas > {compute Global Image Capability Schema Id} > versions: ListComputeGlobalImageCapabilitySchemaVersions",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"computeGlobalImageCapabilitySchemaId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema"
|
|
},
|
|
"functionality": "Lists Compute Global Image Capability Schema versions in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas > {compute Global Image Capability Schema Id} > versions: GetComputeGlobalImageCapabilitySchemaVersion",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}/versions/{computeGlobalImageCapabilitySchemaVersionName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"computeGlobalImageCapabilitySchemaId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema",
|
|
"computeGlobalImageCapabilitySchemaVersionName": "[REQUIRED] string: (Required) The name of the compute global image capability schema version"
|
|
},
|
|
"functionality": "Gets the specified Compute Global Image Capability Schema Version",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas > {compute Global Image Capability Schema Id}: GetComputeGlobalImageCapabilitySchema",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas/{computeGlobalImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"computeGlobalImageCapabilitySchemaId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compute global image capability schema"
|
|
},
|
|
"functionality": "Gets the specified Compute Global Image Capability Schema",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Global Image Capability Schemas: ListComputeGlobalImageCapabilitySchemas",
|
|
"api_call": "GET /computeGlobalImageCapabilitySchemas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that match the given compartment OCID exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists Compute Global Image Capability Schema in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: DeleteComputeImageCapabilitySchema",
|
|
"api_call": "DELETE /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Deletes the specified Compute Image Capability Schema\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: GetComputeImageCapabilitySchema",
|
|
"api_call": "GET /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"isMergeEnabled": "boolean: Merge the image capability schema with the global image capability schema\n",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Gets the specified Compute Image Capability Schema\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: UpdateComputeImageCapabilitySchema",
|
|
"api_call": "PUT /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Updates the specified Compute Image Capability Schema\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas > {compute Image Capability Schema Id}: ChangeComputeImageCapabilitySchemaCompartment",
|
|
"api_call": "POST /computeImageCapabilitySchemas/{computeImageCapabilitySchemaId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"computeImageCapabilitySchemaId": "[REQUIRED] string: (Required) The id of the compute image capability schema or the image ocid"
|
|
},
|
|
"functionality": "Moves a compute image capability schema into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas: ListComputeImageCapabilitySchemas",
|
|
"api_call": "GET /computeImageCapabilitySchemas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that match the given compartment OCID exactly.\n",
|
|
"imageId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of an image.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists Compute Image Capability Schema in the specified compartment. You can also query by a specific imageId.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - compute Image Capability Schemas: CreateComputeImageCapabilitySchema",
|
|
"api_call": "POST /computeImageCapabilitySchemas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates compute image capability schema.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpe Device Shapes: ListCpeDeviceShapes",
|
|
"api_call": "GET /cpeDeviceShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the CPE device types that the Networking service provides CPE configuration\ncontent for (example: Cisco ASA). The content helps a network engineer configure\nthe actual CPE device represented by a [Cpe](#/en/iaas/latest/Cpe/) object.\n\nIf you want to generate CPE configuration content for one of the returned CPE device types,\nensure that the [Cpe](#/en/iaas/latest/Cpe/) object's `cpeDeviceShapeId` attribute is set\nto the CPE device type's [OCID](/Content/General/Concepts/identifiers.htm) (returned by this operation).\n\nFor information about generating CPE configuration content, see these operations:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpe Device Shapes: GetCpeDeviceShape",
|
|
"api_call": "GET /cpeDeviceShapes/{cpeDeviceShapeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeDeviceShapeId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape."
|
|
},
|
|
"functionality": "Gets the detailed information about the specified CPE device type. This might include a set of questions\nthat are specific to the particular CPE device type. The customer must supply answers to those questions\n(see [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)).\nThe service merges the answers with a template of other information for the CPE device type. The following\noperations return the merged content:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: DeleteCpe",
|
|
"api_call": "DELETE /cpes/{cpeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous\noperation. The CPE's `lifecycleState` will change to TERMINATING temporarily until the CPE is completely\nremoved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: GetCpe",
|
|
"api_call": "GET /cpes/{cpeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Gets the specified CPE's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: UpdateCpe",
|
|
"api_call": "PUT /cpes/{cpeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Updates the specified CPE's display name or tags.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: ChangeCpeCompartment",
|
|
"api_call": "POST /cpes/{cpeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Moves a CPE object into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes > {cpe Id}: GetCpeDeviceConfigContent",
|
|
"api_call": "GET /cpes/{cpeId}/cpeConfigContent",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cpeId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the CPE."
|
|
},
|
|
"functionality": "Renders a set of CPE configuration content that can help a network engineer configure the actual\nCPE device (for example, a hardware router) represented by the specified [Cpe](#/en/iaas/latest/Cpe/)\nobject.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) must have the CPE's device type specified by the `cpeDeviceShapeId`\nattribute. The content optionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for *all* of the\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/) objects that use the specified CPE.\nHere are similar operations:\n\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n returns CPE configuration content for all IPSec tunnels in a single IPSec connection.\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n returns CPE configuration content for a specific IPSec tunnel in an IPSec connection.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes: ListCpes",
|
|
"api_call": "GET /cpes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the customer-premises equipment objects (CPEs) in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cpes: CreateCpe",
|
|
"api_call": "POST /cpes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For\nmore information, see [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec\nconnection or other Networking Service components. If you're not sure which compartment to\nuse, put the CPE in the same compartment as the DRG. For more information about\ncompartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou must provide the public IP address of your on-premises router. See\n[CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm).\n\nYou may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to\nbe unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: DeleteCrossConnectGroup",
|
|
"api_call": "DELETE /crossConnectGroups/{crossConnectGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Deletes the specified cross-connect group. It must not contain any\ncross-connects, and it cannot be mapped to a\n[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: GetCrossConnectGroups",
|
|
"api_call": "GET /crossConnectGroups/{crossConnectGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Gets the specified cross-connect group's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: UpdateCrossConnectGroup",
|
|
"api_call": "PUT /crossConnectGroups/{crossConnectGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Updates the specified cross-connect group's display name.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups > {cross Connect Group Id}: ChangeCrossConnectGroupCompartment",
|
|
"api_call": "POST /crossConnectGroups/{crossConnectGroupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectGroupId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group."
|
|
},
|
|
"functionality": "Moves a cross-connect group into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups: ListCrossConnectGroups",
|
|
"api_call": "GET /crossConnectGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the cross-connect groups in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connect Groups: CreateCrossConnectGroup",
|
|
"api_call": "POST /crossConnectGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new cross-connect group to use with Oracle Cloud Infrastructure\nFastConnect. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the cross-connect group to reside. If you're\nnot sure which compartment to use, put the cross-connect group in the\nsame compartment with your VCN. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the cross-connect group.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: DeleteCrossConnect",
|
|
"api_call": "DELETE /crossConnects/{crossConnectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Deletes the specified cross-connect. It must not be mapped to a\n[VirtualCircuit](#/en/iaas/latest/VirtualCircuit/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: GetCrossConnect",
|
|
"api_call": "GET /crossConnects/{crossConnectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Gets the specified cross-connect's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: UpdateCrossConnect",
|
|
"api_call": "PUT /crossConnects/{crossConnectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Updates the specified cross-connect.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: ChangeCrossConnectCompartment",
|
|
"api_call": "POST /crossConnects/{crossConnectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Moves a cross-connect into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: GetCrossConnectLetterOfAuthority",
|
|
"api_call": "GET /crossConnects/{crossConnectId}/letterOfAuthority",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Gets the Letter of Authority for the specified cross-connect.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects > {cross Connect Id}: GetCrossConnectStatus",
|
|
"api_call": "GET /crossConnects/{crossConnectId}/status",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"crossConnectId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect."
|
|
},
|
|
"functionality": "Gets the status of the specified cross-connect.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects: ListCrossConnects",
|
|
"api_call": "GET /crossConnects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"crossConnectGroupId": "string: The [OCID](/Content/General/Concepts/identifiers.htm) of the cross-connect group.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the cross-connects in the specified compartment. You can filter the list\nby specifying the [OCID](/Content/General/Concepts/identifiers.htm) of a cross-connect group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - cross Connects: CreateCrossConnect",
|
|
"api_call": "POST /crossConnects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new cross-connect. Oracle recommends you create each cross-connect in a\n[CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation\nwith the connection.\n\nAfter creating the `CrossConnect` object, you need to go the FastConnect location\nand request to have the physical cable installed. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the cross-connect to reside. If you're\nnot sure which compartment to use, put the cross-connect in the\nsame compartment with your VCN. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the cross-connect.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: DeleteDedicatedVmHost",
|
|
"api_call": "DELETE /dedicatedVmHosts/{dedicatedVmHostId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Deletes the specified dedicated virtual machine host.\n\nIf any VM instances are assigned to the dedicated virtual machine host,\nthe delete operation will fail and the service will return a 409 response code.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: GetDedicatedVmHost",
|
|
"api_call": "GET /dedicatedVmHosts/{dedicatedVmHostId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Gets information about the specified dedicated virtual machine host.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: UpdateDedicatedVmHost",
|
|
"api_call": "PUT /dedicatedVmHosts/{dedicatedVmHostId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Updates the displayName, freeformTags, and definedTags attributes for the specified dedicated virtual machine host.\nIf an attribute value is not included, it will not be updated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: ChangeDedicatedVmHostCompartment",
|
|
"api_call": "POST /dedicatedVmHosts/{dedicatedVmHostId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Moves a dedicated virtual machine host from one compartment to another.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts > {dedicated Vm Host Id}: ListDedicatedVmHostInstances",
|
|
"api_call": "GET /dedicatedVmHosts/{dedicatedVmHostId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"dedicatedVmHostId": "[REQUIRED] string: (Required) The OCID of the dedicated VM host."
|
|
},
|
|
"functionality": "Returns the list of instances on the dedicated virtual machine hosts that match the specified criteria.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts: ListDedicatedVmHosts",
|
|
"api_call": "GET /dedicatedVmHosts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"instanceShapeName": "string: The name for the instance's shape.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"remainingMemoryInGBsGreaterThanOrEqualTo": "number: The remaining memory of the dedicated VM host, in GBs.",
|
|
"remainingOcpusGreaterThanOrEqualTo": "number: The available OCPUs of the dedicated VM host."
|
|
},
|
|
"functionality": "Returns the list of dedicated virtual machine hosts that match the specified criteria in the specified compartment.\n\nYou can limit the list by specifying a dedicated virtual machine host display name. The list will include all the identically-named\ndedicated virtual machine hosts in the compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dedicated Vm Hosts: CreateDedicatedVmHost",
|
|
"api_call": "POST /dedicatedVmHosts",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new dedicated virtual machine host in the specified compartment and the specified availability domain.\nDedicated virtual machine hosts enable you to run your Compute virtual machine (VM) instances on dedicated servers\nthat are a single tenant and not shared with other customers.\nFor more information, see [Dedicated Virtual Machine Hosts](/iaas/Content/Compute/Concepts/dedicatedvmhosts.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: DeleteDhcpOptions",
|
|
"api_call": "DELETE /dhcps/{dhcpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a\nVCN's default set of DHCP options.\n\nThis is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily\nuntil the set is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: GetDhcpOptions",
|
|
"api_call": "GET /dhcps/{dhcpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Gets the specified set of DHCP options.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: UpdateDhcpOptions",
|
|
"api_call": "PUT /dhcps/{dhcpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Updates the specified set of DHCP options. You can update the display name or the options\nthemselves. Avoid entering confidential information.\n\nNote that the `options` object you provide replaces the entire existing set of options.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps > {dhcp Id}: ChangeDhcpOptionsCompartment",
|
|
"api_call": "POST /dhcps/{dhcpId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"dhcpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) for the set of DHCP options."
|
|
},
|
|
"functionality": "Moves a set of DHCP options into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps: ListDhcpOptions",
|
|
"api_call": "GET /dhcps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"vcnId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the sets of DHCP options in the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment.\nThe response includes the default set of options that automatically comes with each VCN,\nplus any other sets you've created.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - dhcps: CreateDhcpOptions",
|
|
"api_call": "POST /dhcps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new set of DHCP options for the specified VCN. For more information, see\n[DhcpOptions](#/en/iaas/latest/DhcpOptions/).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the set of\nDHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN,\nsubnets, or other Networking Service components. If you're not sure which compartment to use, put the set\nof DHCP options in the same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the set of DHCP options, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: DeleteDrgAttachment",
|
|
"api_call": "DELETE /drgAttachments/{drgAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Detaches a DRG from a network resource by deleting the corresponding `DrgAttachment` resource. This is an asynchronous\noperation. The attachment's `lifecycleState` will temporarily change to DETACHING until the attachment\nis completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: GetDrgAttachment",
|
|
"api_call": "GET /drgAttachments/{drgAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Gets the `DrgAttachment` resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: UpdateDrgAttachment",
|
|
"api_call": "PUT /drgAttachments/{drgAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Updates the display name and routing information for the specified `DrgAttachment`.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments > {drg Attachment Id}: RemoveExportDrgRouteDistribution",
|
|
"api_call": "POST /drgAttachments/{drgAttachmentId}/actions/removeExportDrgRouteDistribution",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgAttachmentId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment."
|
|
},
|
|
"functionality": "Removes the export route distribution from the DRG attachment so no routes are advertised to it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments: ListDrgAttachments",
|
|
"api_call": "GET /drgAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"vcnId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN.",
|
|
"drgId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"networkId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG.",
|
|
"attachmentType": "string: The type for the network resource attached to the DRG.",
|
|
"drgRouteTableId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to the DRG attachment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the `DrgAttachment` resource for the specified compartment. You can filter the\nresults by DRG, attached network, attachment type, DRG route table or\nVCN route table.\n\nThe LIST API lists DRG attachments by attachment type. It will default to list VCN attachments,\nbut you may request to list ALL attachments of ALL types. \n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Attachments: CreateDrgAttachment",
|
|
"api_call": "POST /drgAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG\nat a time, but a DRG can be attached to more than one VCN. The response includes a `DrgAttachment`\nobject with its own [OCID](/Content/General/Concepts/identifiers.htm). For more information about DRGs, see\n[Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm).\n\nYou may optionally specify a *display name* for the attachment, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor the purposes of access control, the DRG attachment is automatically placed into the currently selected compartment.\nFor more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id} > actions: AddDrgRouteDistributionStatements",
|
|
"api_call": "POST /drgRouteDistributions/{drgRouteDistributionId}/actions/addDrgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Adds one or more route distribution statements to the specified route distribution.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id} > actions: RemoveDrgRouteDistributionStatements",
|
|
"api_call": "POST /drgRouteDistributions/{drgRouteDistributionId}/actions/removeDrgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Removes one or more route distribution statements from the specified route distribution's map.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id} > actions: UpdateDrgRouteDistributionStatements",
|
|
"api_call": "POST /drgRouteDistributions/{drgRouteDistributionId}/actions/updateDrgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Updates one or more route distribution statements in the specified route distribution.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: DeleteDrgRouteDistribution",
|
|
"api_call": "DELETE /drgRouteDistributions/{drgRouteDistributionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table.\n\nRemove the DRG route distribution from a DRG attachment or DRG route table by using the \"RemoveExportDrgRouteDistribution\" or \"RemoveImportDrgRouteDistribution' operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: GetDrgRouteDistribution",
|
|
"api_call": "GET /drgRouteDistributions/{drgRouteDistributionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Gets the specified route distribution's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: UpdateDrgRouteDistribution",
|
|
"api_call": "PUT /drgRouteDistributions/{drgRouteDistributionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Updates the specified route distribution\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions > {drg Route Distribution Id}: ListDrgRouteDistributionStatements",
|
|
"api_call": "GET /drgRouteDistributions/{drgRouteDistributionId}/drgRouteDistributionStatements",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by.",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"drgRouteDistributionId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution."
|
|
},
|
|
"functionality": "Lists the statements for the specified route distribution.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions: ListDrgRouteDistributionStatements",
|
|
"api_call": "GET /drgRouteDistributions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter that only returns resources that match the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the route distributions in the specified DRG.\n\nTo retrieve the statements in a distribution, use the\nListDrgRouteDistributionStatements operation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Distributions: CreateDrgRouteDistribution",
|
|
"api_call": "POST /drgRouteDistributions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new route distribution for the specified DRG. \nAssign the route distribution as an import distribution to a DRG route table using the `UpdateDrgRouteTable` or `CreateDrgRouteTable` operations.\nAssign the route distribution as an export distribution to a DRG attachment\nusing the `UpdateDrgAttachment` or `CreateDrgAttachment` operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: AddDrgRouteRules",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/addDrgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Adds one or more static route rules to the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: RemoveDrgRouteRules",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/removeDrgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Removes one or more route rules from the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: RemoveImportDrgRouteDistribution",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/removeImportDrgRouteDistribution",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Removes the import route distribution from the DRG route table so no routes are imported\ninto it.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id} > actions: UpdateDrgRouteRules",
|
|
"api_call": "POST /drgRouteTables/{drgRouteTableId}/actions/updateDrgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Updates one or more route rules in the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: DeleteDrgRouteTable",
|
|
"api_call": "DELETE /drgRouteTables/{drgRouteTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Deletes the specified DRG route table. There must not be any DRG attachments assigned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: GetDrgRouteTable",
|
|
"api_call": "GET /drgRouteTables/{drgRouteTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Gets the specified DRG route table's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: UpdateDrgRouteTable",
|
|
"api_call": "PUT /drgRouteTables/{drgRouteTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Updates the specified DRG route table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables > {drg Route Table Id}: ListDrgRouteRules",
|
|
"api_call": "GET /drgRouteTables/{drgRouteTableId}/drgRouteRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"routeType": "string: Static routes are specified through the DRG route table API.\nDynamic routes are learned by the DRG from the DRG attachments through various routing protocols.\n",
|
|
"drgRouteTableId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table."
|
|
},
|
|
"functionality": "Lists the route rules in the specified DRG route table.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables: ListDrgRouteTables",
|
|
"api_call": "GET /drgRouteTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"importDrgRouteDistributionId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution.\n",
|
|
"lifecycleState": "string: A filter that only returns matches for the specified lifecycle\nstate. The value is case insensitive.\n"
|
|
},
|
|
"functionality": "Lists the DRG route tables for the specified DRG.\n\nUse the `ListDrgRouteRules` operation to retrieve the route rules in a table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drg Route Tables: CreateDrgRouteTable",
|
|
"api_call": "POST /drgRouteTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment\nusing the `UpdateDrgAttachment` or `CreateDrgAttachment` operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id} > actions: GetAllDrgAttachments",
|
|
"api_call": "POST /drgs/{drgId}/actions/getAllDrgAttachments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"attachmentType": "string: The type for the network resource attached to the DRG.",
|
|
"isCrossTenancy": "boolean: Whether the DRG attachment lives in a different tenancy than the DRG.",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Returns a complete list of DRG attachments that belong to a particular DRG.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id} > actions: UpgradeDrg",
|
|
"api_call": "POST /drgs/{drgId}/actions/upgrade",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Upgrades the DRG. After upgrade, you can control routing inside your DRG\nvia DRG attachments, route distributions, and DRG route tables.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id} > actions: UpgradeStatus",
|
|
"api_call": "GET /drgs/{drgId}/actions/upgradeStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: DeleteDrg",
|
|
"api_call": "DELETE /drgs/{drgId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise\nnetwork. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous\noperation. The DRG's `lifecycleState` will change to TERMINATING temporarily until the DRG is completely\nremoved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: GetDrg",
|
|
"api_call": "GET /drgs/{drgId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Gets the specified DRG's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: UpdateDrg",
|
|
"api_call": "PUT /drgs/{drgId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Updates the specified DRG's display name or tags. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs > {drg Id}: GetDrgRedundancyStatus",
|
|
"api_call": "GET /drgs/{drgId}/redundancyStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"drgId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the DRG."
|
|
},
|
|
"functionality": "Gets the redundancy status for the specified DRG. For more information, see\n[Redundancy Remedies](/iaas/Content/Network/Troubleshoot/drgredundancy.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs: ListDrgs",
|
|
"api_call": "GET /drgs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the DRGs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - drgs: CreateDrg",
|
|
"api_call": "POST /drgs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information,\nsee [Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN,\nthe DRG attachment, or other Networking Service components. If you're not sure which compartment\nto use, put the DRG in the same compartment as the VCN. For more information about compartments\nand access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the DRG, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services > {provider Service Id}: GetFastConnectProviderService",
|
|
"api_call": "GET /fastConnectProviderServices/{providerServiceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"providerServiceId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service."
|
|
},
|
|
"functionality": "Gets the specified provider service.\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services > {provider Service Id}: GetFastConnectProviderServiceKey",
|
|
"api_call": "GET /fastConnectProviderServices/{providerServiceId}/providerServiceKeys/{providerServiceKeyName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"providerServiceId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service.",
|
|
"providerServiceKeyName": "[REQUIRED] string: (Required) The provider service key that the provider gives you when you set up a virtual circuit connection\nfrom the provider to Oracle Cloud Infrastructure. You can set up that connection and get your\nprovider service key at the provider's website or portal. For the portal location, see the `description`\nattribute of the [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/).\n"
|
|
},
|
|
"functionality": "Gets the specified provider service key's information. Use this operation to validate a\nprovider service key. An invalid key returns a 404 error.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services > {provider Service Id}: ListFastConnectProviderVirtualCircuitBandwidthShapes",
|
|
"api_call": "GET /fastConnectProviderServices/{providerServiceId}/virtualCircuitBandwidthShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"providerServiceId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the provider service."
|
|
},
|
|
"functionality": "Gets the list of available virtual circuit bandwidth levels for a provider.\nYou need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit.\n\nFor more information about virtual circuits, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - fast Connect Provider Services: ListFastConnectProviderServices",
|
|
"api_call": "GET /fastConnectProviderServices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the service offerings from supported providers. You need this\ninformation so you can specify your desired provider and service\noffering when you create a virtual circuit.\n\nFor the compartment ID, provide the [OCID](/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).\n\nFor more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > actions: ChangeImageCompartment",
|
|
"api_call": "POST /images/{imageId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Moves an image into a different compartment within the same tenancy. For information about moving\nresources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > actions: ExportImage",
|
|
"api_call": "POST /images/{imageId}/actions/export",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Exports the specified image to the Oracle Cloud Infrastructure Object Storage service. You can use the Object Storage URL,\nor the namespace, bucket name, and object name when specifying the location to export to.\n\nFor more information about exporting images, see [Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm).\n\nTo perform an image export, you need write access to the Object Storage bucket for the image,\nsee [Let Users Write Objects to Object Storage Buckets](/iaas/Content/Identity/Concepts/commonpolicies.htm#Let4).\n\nSee [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm)\nfor constructing URLs for image import/export.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes > {shape Name}: RemoveImageShapeCompatibilityEntry",
|
|
"api_call": "DELETE /images/{imageId}/shapes/{shapeName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.",
|
|
"shapeName": "[REQUIRED] string: (Required) Shape name."
|
|
},
|
|
"functionality": "Removes a shape from the compatible shapes list for the image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes > {shape Name}: GetImageShapeCompatibilityEntry",
|
|
"api_call": "GET /images/{imageId}/shapes/{shapeName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.",
|
|
"shapeName": "[REQUIRED] string: (Required) Shape name."
|
|
},
|
|
"functionality": "Retrieves an image shape compatibility entry.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes > {shape Name}: AddImageShapeCompatibilityEntry",
|
|
"api_call": "PUT /images/{imageId}/shapes/{shapeName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image.",
|
|
"shapeName": "[REQUIRED] string: (Required) Shape name."
|
|
},
|
|
"functionality": "Adds a shape to the compatible shapes list for the image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id} > shapes: ListImageShapeCompatibilityEntries",
|
|
"api_call": "GET /images/{imageId}/shapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Lists the compatible shapes for the specified image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id}: DeleteImage",
|
|
"api_call": "DELETE /images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Deletes an image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id}: GetImage",
|
|
"api_call": "GET /images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Gets the specified image.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images > {image Id}: UpdateImage",
|
|
"api_call": "PUT /images/{imageId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"imageId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the image."
|
|
},
|
|
"functionality": "Updates the display name of the image. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images: ListImages",
|
|
"api_call": "GET /images",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists a subset of images available in the specified compartment, including\n[platform images](/iaas/Content/Compute/References/images.htm) and\n[custom images](/iaas/Content/Compute/Tasks/managingcustomimages.htm). \nThe list of platform images includes the three most recently published versions \nof each major distribution.\n\nThe list of images returned is ordered to first show the recent platform images,\nthen all of the custom images.\n\n**Caution:** Platform images are refreshed regularly. When new images are released, older versions are replaced. \nThe image OCIDs remain available, but when the platform image is replaced, the image OCIDs are no longer returned as part of the platform image list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - images: CreateImage",
|
|
"api_call": "POST /images",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a boot disk image for the specified instance or imports an exported image from the Oracle Cloud Infrastructure Object Storage service.\n\nWhen creating a new image, you must provide the OCID of the instance you want to use as the basis for the image, and\nthe OCID of the compartment containing that instance. For more information about images,\nsee [Managing Custom Images](/iaas/Content/Compute/Tasks/managingcustomimages.htm).\n\nWhen importing an exported image from Object Storage, you specify the source information\nin [ImageSourceDetails](#/en/iaas/latest/requests/ImageSourceDetails).\n\nWhen importing an image based on the namespace, bucket name, and object name,\nuse [ImageSourceViaObjectStorageTupleDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageTupleDetails).\n\nWhen importing an image based on the Object Storage URL, use\n[ImageSourceViaObjectStorageUriDetails](#/en/iaas/latest/requests/ImageSourceViaObjectStorageUriDetails).\nSee [Object Storage URLs](/iaas/Content/Compute/Tasks/imageimportexport.htm#URLs) and [Using Pre-Authenticated Requests](/iaas/Content/Object/Tasks/usingpreauthenticatedrequests.htm)\nfor constructing URLs for image import/export.\n\nFor more information about importing exported images, see\n[Image Import/Export](/iaas/Content/Compute/Tasks/imageimportexport.htm).\n\nYou may optionally specify a *display name* for the image, which is simply a friendly name or description.\nIt does not have to be unique, and you can change it. See [UpdateImage](#/en/iaas/latest/Image/UpdateImage).\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id} > actions: ChangeInstanceConfigurationCompartment",
|
|
"api_call": "POST /instanceConfigurations/{instanceConfigurationId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Moves an instance configuration into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance configuration to a different compartment, associated resources such as\ninstance pools are not moved.\n\n**Important:** Most of the properties for an existing instance configuration, including the compartment,\ncannot be modified after you create the instance configuration. Although you can move an instance configuration\nto a different compartment, you will not be able to use the instance configuration to manage instance pools\nin the new compartment. If you want to update an instance configuration to point to a different compartment,\nyou should instead create a new instance configuration in the target compartment using\n[CreateInstanceConfiguration](/iaas/api/#/en/iaas/20160918/InstanceConfiguration/CreateInstanceConfiguration).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id} > actions: LaunchInstanceConfiguration",
|
|
"api_call": "POST /instanceConfigurations/{instanceConfigurationId}/actions/launch",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Launches an instance from an instance configuration.\n\nIf the instance configuration does not include all of the parameters that are\nrequired to launch an instance, such as the availability domain and subnet ID, you must\nprovide these parameters when you launch an instance from the instance configuration.\nFor more information, see the [InstanceConfiguration](#/en/iaas/latest/InstanceConfiguration/)\nresource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id}: DeleteInstanceConfiguration",
|
|
"api_call": "DELETE /instanceConfigurations/{instanceConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Deletes an instance configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id}: GetInstanceConfiguration",
|
|
"api_call": "GET /instanceConfigurations/{instanceConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Gets the specified instance configuration",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations > {instance Configuration Id}: UpdateInstanceConfiguration",
|
|
"api_call": "PUT /instanceConfigurations/{instanceConfigurationId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConfigurationId": "[REQUIRED] string: (Required) The OCID of the instance configuration."
|
|
},
|
|
"functionality": "Updates the free-form tags, defined tags, and display name of an instance configuration.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations: ListInstanceConfigurations",
|
|
"api_call": "GET /instanceConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the instance configurations in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Configurations: CreateInstanceConfiguration",
|
|
"api_call": "POST /instanceConfigurations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates an instance configuration. An instance configuration is a template that defines the\nsettings to use when creating Compute instances.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections > {instance Console Connection Id}: DeleteInstanceConsoleConnection",
|
|
"api_call": "DELETE /instanceConsoleConnections/{instanceConsoleConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleConnectionId": "[REQUIRED] string: (Required) The OCID of the instance console connection."
|
|
},
|
|
"functionality": "Deletes the specified instance console connection.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections > {instance Console Connection Id}: GetInstanceConsoleConnection",
|
|
"api_call": "GET /instanceConsoleConnections/{instanceConsoleConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleConnectionId": "[REQUIRED] string: (Required) The OCID of the instance console connection."
|
|
},
|
|
"functionality": "Gets the specified instance console connection's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections > {instance Console Connection Id}: UpdateInstanceConsoleConnection",
|
|
"api_call": "PUT /instanceConsoleConnections/{instanceConsoleConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConsoleConnectionId": "[REQUIRED] string: (Required) The OCID of the instance console connection."
|
|
},
|
|
"functionality": "Updates the defined tags and free-form tags for the specified instance console connection.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections: ListInstanceConsoleConnections",
|
|
"api_call": "GET /instanceConsoleConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the console connections for the specified compartment or instance.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Connections: CreateInstanceConsoleConnection",
|
|
"api_call": "POST /instanceConsoleConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new console connection to the specified instance.\nAfter the console connection has been created and is available,\nyou connect to the console using SSH.\n\nFor more information about instance console connections, see [Troubleshooting Instances Using Instance Console Connections](/iaas/Content/Compute/References/serialconsole.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: DeleteConsoleHistory",
|
|
"api_call": "DELETE /instanceConsoleHistories/{instanceConsoleHistoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Deletes the specified console history metadata and the console history data.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: GetConsoleHistory",
|
|
"api_call": "GET /instanceConsoleHistories/{instanceConsoleHistoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Shows the metadata for the specified console history.\nSee [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)\nfor details about using the console history operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: UpdateConsoleHistory",
|
|
"api_call": "PUT /instanceConsoleHistories/{instanceConsoleHistoryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Updates the specified console history metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories > {instance Console History Id}: GetConsoleHistoryContent",
|
|
"api_call": "GET /instanceConsoleHistories/{instanceConsoleHistoryId}/data",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"offset": "integer: Offset of the snapshot data to retrieve.",
|
|
"length": "integer: Length of the snapshot data to retrieve.",
|
|
"instanceConsoleHistoryId": "[REQUIRED] string: (Required) The OCID of the console history."
|
|
},
|
|
"functionality": "Gets the actual console history data (not the metadata).\nSee [CaptureConsoleHistory](#/en/iaas/latest/ConsoleHistory/CaptureConsoleHistory)\nfor details about using the console history operations.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories: ListConsoleHistories",
|
|
"api_call": "GET /instanceConsoleHistories/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the console history metadata for the specified compartment or instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Console Histories: CaptureConsoleHistory",
|
|
"api_call": "POST /instanceConsoleHistories/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Captures the most recent serial console data (up to a megabyte) for the\nspecified instance.\n\nThe `CaptureConsoleHistory` operation works with the other console history operations\nas described below.\n\n1. Use `CaptureConsoleHistory` to request the capture of up to a megabyte of the\nmost recent console history. This call returns a `ConsoleHistory`\nobject. The object will have a state of REQUESTED.\n2. Wait for the capture operation to succeed by polling `GetConsoleHistory` with\nthe identifier of the console history metadata. The state of the\n`ConsoleHistory` object will go from REQUESTED to GETTING-HISTORY and\nthen SUCCEEDED (or FAILED).\n3. Use `GetConsoleHistoryContent` to get the actual console history data (not the\nmetadata).\n4. Optionally, use `DeleteConsoleHistory` to delete the console history metadata\nand the console history data.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: AttachLoadBalancer",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/attachLoadBalancer",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Attach a load balancer to the instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: ChangeInstancePoolCompartment",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Moves an instance pool into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance pool to a different compartment, associated resources such as the instances in\nthe pool, boot volumes, VNICs, and autoscaling configurations are not moved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: DetachInstancePoolInstance",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/detachInstance",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Detaches an instance from an instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: DetachLoadBalancer",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/detachLoadBalancer",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Detach a load balancer from the instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: ResetInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/reset",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the reset (immediate power off and power on) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: SoftresetInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/softreset",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the softreset (ACPI shutdown and power on) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n\nSoftreset gracefully reboots the instances by sending a shutdown command to the operating systems.\nAfter waiting 15 minutes for the OS to shut down, the instances are powered off and then powered back on.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: StartInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the start (power on) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > actions: StopInstancePool",
|
|
"api_call": "POST /instancePools/{instancePoolId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Performs the stop (immediate power off) action on the specified instance pool,\nwhich performs the action on all the instances in the pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > instances: ListInstancePoolInstances",
|
|
"api_call": "GET /instancePools/{instancePoolId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "List the instances in the specified instance pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > instances: AttachInstancePoolInstance",
|
|
"api_call": "POST /instancePools/{instancePoolId}/instances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Attaches an instance to an instance pool. For information about the prerequisites\nthat an instance must meet before you can attach it to a pool, see\n[Attaching an Instance to an Instance Pool](/iaas/Content/Compute/Tasks/updatinginstancepool.htm#attach-instance).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id} > instances: GetInstancePoolInstance",
|
|
"api_call": "GET /instancePools/{instancePoolId}/instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets information about an instance that belongs to an instance pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: TerminateInstancePool",
|
|
"api_call": "DELETE /instancePools/{instancePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Terminate the specified instance pool.\n\n**Warning:** When you delete an instance pool, the resources that were created by the pool are permanently\ndeleted, including associated instances, attached boot volumes, and block volumes.\n\nIf an autoscaling configuration applies to the instance pool, the autoscaling configuration will be deleted\nasynchronously after the pool is deleted. You can also manually delete the autoscaling configuration using\nthe `DeleteAutoScalingConfiguration` operation in the Autoscaling API.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: GetInstancePool",
|
|
"api_call": "GET /instancePools/{instancePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Gets the specified instance pool",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: UpdateInstancePool",
|
|
"api_call": "PUT /instancePools/{instancePoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool."
|
|
},
|
|
"functionality": "Update the specified instance pool.\n\nThe OCID of the instance pool remains the same.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools > {instance Pool Id}: GetLoadBalancerAttachment",
|
|
"api_call": "GET /instancePools/{instancePoolId}/loadBalancerAttachments/{instancePoolLoadBalancerAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instancePoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance pool.",
|
|
"instancePoolLoadBalancerAttachmentId": "[REQUIRED] string: (Required) The OCID of the load balancer attachment."
|
|
},
|
|
"functionality": "Gets information about a load balancer that is attached to the specified instance pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools: ListInstancePools",
|
|
"api_call": "GET /instancePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle state. The state\nvalue is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the instance pools in the specified compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instance Pools: CreateInstancePool",
|
|
"api_call": "POST /instancePools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Create an instance pool.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id} > actions: AcceptShieldedIntegrityPolicy",
|
|
"api_call": "POST /instances/{instanceId}/actions/acceptShieldedIntegrityPolicy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Accept the changes to the PCR values in the measured boot report.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id} > actions: ChangeInstanceCompartment",
|
|
"api_call": "POST /instances/{instanceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Moves an instance into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen you move an instance to a different compartment, associated resources such as boot volumes and VNICs\nare not moved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: TerminateInstance",
|
|
"api_call": "DELETE /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"preserveBootVolume": "boolean: Specifies whether to delete or preserve the boot volume when terminating an instance.\nWhen set to `true`, the boot volume is preserved. The default value is `false`.\n",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Terminates the specified instance. Any attached VNICs and volumes are automatically detached\nwhen the instance terminates.\n\nTo preserve the boot volume associated with the instance, specify `true` for `PreserveBootVolumeQueryParam`.\nTo delete the boot volume when the instance is deleted, specify `false` or do not specify a value for `PreserveBootVolumeQueryParam`.\n\nThis is an asynchronous operation. The instance's `lifecycleState` will change to TERMINATING temporarily\nuntil the instance is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetInstance",
|
|
"api_call": "GET /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets information about the specified instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: InstanceAction",
|
|
"api_call": "POST /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"Content-Type": "string",
|
|
"action": "string: (Required) The action to perform on the instance.",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Performs one of the following power actions on the specified instance:\n\n- **START** - Powers on the instance.\n\n- **STOP** - Powers off the instance.\n\n- **RESET** - Powers off the instance and then powers it back on.\n\n- **SOFTSTOP** - Gracefully shuts down the instance by sending a shutdown command to the operating system.\nAfter waiting 15 minutes for the OS to shut down, the instance is powered off.\nIf the applications that run on the instance take more than 15 minutes to shut down, they could be improperly stopped, resulting\nin data corruption. To avoid this, manually shut down the instance using the commands available in the OS before you softstop the\ninstance.\n\n- **SOFTRESET** - Gracefully reboots the instance by sending a shutdown command to the operating system.\nAfter waiting 15 minutes for the OS to shut down, the instance is powered off and\nthen powered back on.\n\n- **SENDDIAGNOSTICINTERRUPT** - For advanced users. **Warning: Sending a diagnostic interrupt to a live system can\ncause data corruption or system failure.** Sends a diagnostic interrupt that causes the instance's\nOS to crash and then reboot. Before you send a diagnostic interrupt, you must configure the instance to generate a\ncrash dump file when it crashes. The crash dump captures information about the state of the OS at the time of\nthe crash. After the OS restarts, you can analyze the crash dump to diagnose the issue. For more information, see\n[Sending a Diagnostic Interrupt](/iaas/Content/Compute/Tasks/sendingdiagnosticinterrupt.htm).\n\n\nFor more information about managing instance lifecycle states, see\n[Stopping and Starting an Instance](/iaas/Content/Compute/Tasks/restartinginstance.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: UpdateInstance",
|
|
"api_call": "PUT /instances/{instanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Updates certain fields on the specified instance. Fields that are not provided in the\nrequest will not be updated. Avoid entering confidential information.\n\nChanges to metadata fields will be reflected in the instance metadata service (this may take\nup to a minute).\n\nThe OCID of the instance remains the same.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetInstanceDefaultCredentials",
|
|
"api_call": "GET /instances/{instanceId}/defaultCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.\nFor certain operating systems, users will be forced to change the initial credentials.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: ListInstanceDevices",
|
|
"api_call": "GET /instances/{instanceId}/devices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"isAvailable": "boolean: A filter to return only available devices or only used devices.\n",
|
|
"name": "string: A filter to return only devices that match the given name exactly.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets a list of all the devices for given instance. You can optionally filter results by device availability.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetWindowsInstanceInitialCredentials",
|
|
"api_call": "GET /instances/{instanceId}/initialCredentials",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Deprecated. Use [GetInstanceDefaultCredentials](#/en/iaas/latest/InstanceCredentials/GetInstanceDefaultCredentials) instead.\n\nGets the generated credentials for the instance. Only works for instances that require a password to log in, such as Windows.\nFor certain operating systems, users will be forced to change the initial credentials.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances > {instance Id}: GetMeasuredBootReport",
|
|
"api_call": "GET /instances/{instanceId}/measuredBootReport",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"instanceId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the instance."
|
|
},
|
|
"functionality": "Gets the measured boot report for this shielded instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances: ListInstances",
|
|
"api_call": "GET /instances/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the instances in the specified compartment and the specified availability domain.\nYou can filter the results by specifying an instance name (the list will include all the identically-named\ninstances in the compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - instances: LaunchInstance",
|
|
"api_call": "POST /instances/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new instance in the specified compartment and the specified availability domain.\nFor general information about instances, see\n[Overview of the Compute Service](/iaas/Content/Compute/Concepts/computeoverview.htm).\n\nFor information about access control and compartments, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nFor information about availability domains, see\n[Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).\nTo get a list of availability domains, use the `ListAvailabilityDomains` operation\nin the Identity and Access Management Service API.\n\nAll Oracle Cloud Infrastructure resources, including instances, get an Oracle-assigned,\nunique ID called an Oracle Cloud Identifier (OCID).\nWhen you create a resource, you can find its OCID in the response. You can\nalso retrieve a resource's OCID by using a List API operation\non that resource type, or by viewing the resource in the Console.\n\nTo launch an instance using an image or a boot volume use the `sourceDetails` parameter in [LaunchInstanceDetails](#/en/iaas/latest/LaunchInstanceDetails).\n\nWhen you launch an instance, it is automatically attached to a virtual\nnetwork interface card (VNIC), called the *primary VNIC*. The VNIC\nhas a private IP address from the subnet's CIDR. You can either assign a\nprivate IP address of your choice or let Oracle automatically assign one.\nYou can choose whether the instance has a public IP address. To retrieve the\naddresses, use the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation to get the VNIC ID for the instance, and then call\n[GetVnic](#/en/iaas/latest/Vnic/GetVnic) with the VNIC ID.\n\nYou can later add secondary VNICs to an instance. For more information, see\n[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).\n\nTo launch an instance from a Marketplace image listing, you must provide the image ID of the\nlisting resource version that you want, but you also must subscribe to the listing before you try\nto launch the instance. To subscribe to the listing, use the [GetAppCatalogListingAgreements](#/en/iaas/latest/AppCatalogListingResourceVersionAgreements/GetAppCatalogListingAgreements)\noperation to get the signature for the terms of use agreement for the desired listing resource version.\nThen, call [CreateAppCatalogSubscription](#/en/iaas/latest/AppCatalogSubscription/CreateAppCatalogSubscription)\nwith the signature. To get the image ID for the LaunchInstance operation, call\n[GetAppCatalogListingResourceVersion](#/en/iaas/latest/AppCatalogListingResourceVersion/GetAppCatalogListingResourceVersion).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: DeleteInternetGateway",
|
|
"api_call": "DELETE /internetGateways/{igId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Deletes the specified internet gateway. The internet gateway does not have to be disabled, but\nthere must not be a route table that lists it as a target.\n\nThis is an asynchronous operation. The gateway's `lifecycleState` will change to TERMINATING temporarily\nuntil the gateway is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: GetInternetGateway",
|
|
"api_call": "GET /internetGateways/{igId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Gets the specified internet gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: UpdateInternetGateway",
|
|
"api_call": "PUT /internetGateways/{igId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Updates the specified internet gateway. You can disable/enable it, or change its display name\nor tags. Avoid entering confidential information.\n\nIf the gateway is disabled, that means no traffic will flow to/from the internet even if there's\na route rule that enables that traffic.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways > {ig Id}: ChangeInternetGatewayCompartment",
|
|
"api_call": "POST /internetGateways/{igId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"igId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the internet gateway."
|
|
},
|
|
"functionality": "Moves an internet gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways: ListInternetGateways",
|
|
"api_call": "GET /internetGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the internet gateways in the specified VCN and the specified compartment.\nIf the VCN ID is not provided, then the list includes the internet gateways from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - internet Gateways: CreateInternetGateway",
|
|
"api_call": "POST /internetGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new internet gateway for the specified VCN. For more information, see\n[Access to the Internet](/iaas/Content/Network/Tasks/managingIGs.htm).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the Internet\nGateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or\nother Networking Service components. If you're not sure which compartment to use, put the Internet\nGateway in the same compartment with the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nYou may optionally specify a *display name* for the internet gateway, otherwise a default is provided. It\ndoes not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in\nthe subnet's route table (for example, 0.0.0.0/0 > internet gateway). See\n[UpdateRouteTable](#/en/iaas/latest/RouteTable/UpdateRouteTable).\n\nYou must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no\ntraffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later\nuse [UpdateInternetGateway](#/en/iaas/latest/InternetGateway/UpdateInternetGateway) to easily disable/enable\nthe gateway without changing the route rule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > shared Secret: GetIPSecConnectionTunnelSharedSecret",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Gets the specified tunnel's shared secret (pre-shared key). To get other information\nabout the tunnel, use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > shared Secret: UpdateIPSecConnectionTunnelSharedSecret",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Updates the shared secret (pre-shared key) for the specified tunnel.\n\n**Important:** If you change the shared secret, the tunnel will go down while it's reprovisioned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > tunnel Device Config: GetTunnelCpeDeviceConfig",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Gets the set of CPE configuration answers for the tunnel, which the customer provided in\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig).\nTo get the full set of content for the tunnel (any answers merged with the template of other\ninformation specific to the CPE device type), use\n[GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > tunnel Device Config: UpdateTunnelCpeDeviceConfig",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Creates or updates the set of CPE configuration answers for the specified tunnel.\nThe answers correlate to the questions that are specific to the CPE device type (see the\n`parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id} > tunnel Device Config: GetTunnelCpeDeviceConfigContent",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a\nnetwork engineer configure the actual CPE device (for example, a hardware router) that the specified\nIPSec tunnel terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content\noptionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for only the specified IPSec tunnel.\nHere are other similar operations:\n\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n returns CPE configuration content for all tunnels in a single IPSec connection.\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n returns CPE configuration content for *all* IPSec connections that use a specific CPE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id}: GetIPSecConnectionTunnel",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels/{tunnelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Gets the specified tunnel's information. The resulting object does not include the tunnel's\nshared secret (pre-shared key). To retrieve that, use\n[GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels > {tunnel Id}: UpdateIPSecConnectionTunnelDetails",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}/tunnels/{tunnelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection.",
|
|
"tunnelId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel."
|
|
},
|
|
"functionality": "Updates the specified tunnel. This operation lets you change tunnel attributes such as the\nrouting type (BGP dynamic routing or static routing). Here are some important notes:\n\n * If you change the tunnel's routing type or BGP session configuration, the tunnel will go\n down while it's reprovisioned.\n\n * If you want to switch the tunnel's `routing` from `STATIC` to `BGP`, make sure the tunnel's\n BGP session configuration attributes have been set ([bgpSessionConfig](#/en/iaas/latest/datatypes/BgpSessionInfo)).\n\n * If you want to switch the tunnel's `routing` from `BGP` to `STATIC`, make sure the\n [IPSecConnection](#/en/iaas/latest/IPSecConnection/) already has at least one valid CIDR\n static route.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id} > tunnels: ListIPSecConnectionTunnels",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/tunnels",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Lists the tunnel information for the specified IPSec connection.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: DeleteIPSecConnection",
|
|
"api_call": "DELETE /ipsecConnections/{ipscId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and\non-premises network, it's easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact.\nIf you were to delete all the components and then later need to create an Site-to-Site VPN again, you would\nneed to configure your on-premises router again with the new information returned from\n[CreateIPSecConnection](#/en/iaas/latest/IPSecConnection/CreateIPSecConnection).\n\nThis is an asynchronous operation. The connection's `lifecycleState` will change to TERMINATING temporarily\nuntil the connection is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIPSecConnection",
|
|
"api_call": "GET /ipsecConnections/{ipscId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Gets the specified IPSec connection's basic information, including the static routes for the\non-premises router. If you want the status of the connection (whether it's up or down), use\n[GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: UpdateIPSecConnection",
|
|
"api_call": "PUT /ipsecConnections/{ipscId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Updates the specified IPSec connection.\n\nTo update an individual IPSec tunnel's attributes, use\n[UpdateIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/UpdateIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: ChangeIPSecConnectionCompartment",
|
|
"api_call": "POST /ipsecConnections/{ipscId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Moves an IPSec connection into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIpsecCpeDeviceConfigContent",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/cpeConfigContent",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Renders a set of CPE configuration content for the specified IPSec connection (for all the\ntunnels in the connection). The content helps a network engineer configure the actual CPE\ndevice (for example, a hardware router) that the specified IPSec connection terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content\noptionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for all tunnels in the single specified\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/) object. Here are other similar\noperations:\n\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n returns CPE configuration content for a specific tunnel within an IPSec connection.\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n returns CPE configuration content for *all* IPSec connections that use a specific CPE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIPSecConnectionDeviceConfig",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/deviceConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Deprecated. To get tunnel information, instead use:\n\n* [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel)\n* [GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections > {ipsc Id}: GetIPSecConnectionDeviceStatus",
|
|
"api_call": "GET /ipsecConnections/{ipscId}/deviceStatus",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipscId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the IPSec connection."
|
|
},
|
|
"functionality": "Deprecated. To get the tunnel status, instead use\n[GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections: ListIPSecConnections",
|
|
"api_call": "GET /ipsecConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the IPSec connections for the specified compartment. You can filter the\nresults by DRG or CPE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipsec Connections: CreateIPSecConnection",
|
|
"api_call": "POST /ipsecConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new IPSec connection between the specified DRG and CPE. For more information, see\n[Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nIf you configure at least one tunnel to use static routing, then in the request you must provide\nat least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16.\nIf you configure both tunnels to use BGP dynamic routing, you can provide an empty list for\nthe static routes. For more information, see the important note in\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/).\n\nFor the purposes of access control, you must provide the [OCID](/Content/General/Concepts/identifiers.htm) of the compartment where you want the\nIPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment\nas the DRG, CPE, or other Networking Service components. If you're not sure which compartment to\nuse, put the IPSec connection in the same compartment as the DRG. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nYou may optionally specify a *display name* for the IPSec connection, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nAfter creating the IPSec connection, you need to configure your on-premises router\nwith tunnel-specific information. For tunnel status and the required configuration information, see:\n\n * [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)\n * [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/)\n\nFor each tunnel, you need the IP address of Oracle's VPN headend and the shared secret\n(that is, the pre-shared key). For more information, see\n[CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6 > {ipv6Id}: DeleteIpv6",
|
|
"api_call": "DELETE /ipv6/{ipv6Id}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipv6Id": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6."
|
|
},
|
|
"functionality": "Unassigns and deletes the specified IPv6. You must specify the object's [OCID](/Content/General/Concepts/identifiers.htm).\nThe IPv6 address is returned to the subnet's pool of available addresses.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6 > {ipv6Id}: GetIpv6",
|
|
"api_call": "GET /ipv6/{ipv6Id}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"ipv6Id": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6."
|
|
},
|
|
"functionality": "Gets the specified IPv6. You must specify the object's [OCID](/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListIpv6s](#/en/iaas/latest/Ipv6/ListIpv6s)\nwith the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6 > {ipv6Id}: UpdateIpv6",
|
|
"api_call": "PUT /ipv6/{ipv6Id}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"ipv6Id": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6."
|
|
},
|
|
"functionality": "Updates the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n * Move an IPv6 to a different VNIC in the same subnet.\n * Enable/disable internet access for an IPv6.\n * Change the display name for an IPv6.\n * Update resource tags for an IPv6.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6: ListIpv6s",
|
|
"api_call": "GET /ipv6",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"ipAddress": "string: An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n",
|
|
"subnetId": "string: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet.",
|
|
"vnicId": "string: The OCID of the VNIC."
|
|
},
|
|
"functionality": "Lists the [IPv6](#/en/iaas/latest/Ipv6/) objects based\non one of these filters:\n\n * Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * Both IPv6 address and subnet OCID: This lets you get an `Ipv6` object based on its private\n IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetIpv6](#/en/iaas/latest/Ipv6/GetIpv6) requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - ipv6: CreateIpv6",
|
|
"api_call": "POST /ipv6",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates an IPv6 for the specified VNIC.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id} > actions: ChangeLocalPeeringGatewayCompartment",
|
|
"api_call": "POST /localPeeringGateways/{localPeeringGatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Moves a local peering gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id} > actions: ConnectLocalPeeringGateways",
|
|
"api_call": "POST /localPeeringGateways/{localPeeringGatewayId}/actions/connect",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Connects this local peering gateway (LPG) to another one in the same region.\n\nThis operation must be called by the VCN administrator who is designated as\nthe *requestor* in the peering relationship. The *acceptor* must implement\nan Identity and Access Management (IAM) policy that gives the requestor permission\nto connect to LPGs in the acceptor's compartment. Without that permission, this\noperation will fail. For more information, see\n[VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id}: DeleteLocalPeeringGateway",
|
|
"api_call": "DELETE /localPeeringGateways/{localPeeringGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Deletes the specified local peering gateway (LPG).\n\nThis is an asynchronous operation; the local peering gateway's `lifecycleState` changes to TERMINATING temporarily\nuntil the local peering gateway is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id}: GetLocalPeeringGateway",
|
|
"api_call": "GET /localPeeringGateways/{localPeeringGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Gets the specified local peering gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways > {local Peering Gateway Id}: UpdateLocalPeeringGateway",
|
|
"api_call": "PUT /localPeeringGateways/{localPeeringGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"localPeeringGatewayId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the local peering gateway."
|
|
},
|
|
"functionality": "Updates the specified local peering gateway (LPG).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways: ListLocalPeeringGateways",
|
|
"api_call": "GET /localPeeringGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"vcnId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Lists the local peering gateways (LPGs) for the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - local Peering Gateways: CreateLocalPeeringGateway",
|
|
"api_call": "POST /localPeeringGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new local peering gateway (LPG) for the specified VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: DeleteNatGateway",
|
|
"api_call": "DELETE /natGateways/{natGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there\nmust not be a route rule that lists the NAT gateway as a target.\n\nThis is an asynchronous operation. The NAT gateway's `lifecycleState` will change to\nTERMINATING temporarily until the NAT gateway is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: GetNatGateway",
|
|
"api_call": "GET /natGateways/{natGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Gets the specified NAT gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: UpdateNatGateway",
|
|
"api_call": "PUT /natGateways/{natGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Updates the specified NAT gateway.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways > {nat Gateway Id}: ChangeNatGatewayCompartment",
|
|
"api_call": "POST /natGateways/{natGatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"natGatewayId": "[REQUIRED] string: (Required) The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Moves a NAT gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways: ListNatGateways",
|
|
"api_call": "GET /natGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID\nto filter the results by VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - nat Gateways: CreateNatGateway",
|
|
"api_call": "POST /natGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the\nNAT gateway as the rule's target. See [Route Table](#/en/iaas/latest/RouteTable/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: AddNetworkSecurityGroupSecurityRules",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/addSecurityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Adds one or more security rules to the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: ChangeNetworkSecurityGroupCompartment",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Moves a network security group into a different compartment within the same tenancy. For\ninformation about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: RemoveNetworkSecurityGroupSecurityRules",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/removeSecurityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Removes one or more security rules from the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id} > actions: UpdateNetworkSecurityGroupSecurityRules",
|
|
"api_call": "POST /networkSecurityGroups/{networkSecurityGroupId}/actions/updateSecurityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Updates one or more security rules in the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: DeleteNetworkSecurityGroup",
|
|
"api_call": "DELETE /networkSecurityGroups/{networkSecurityGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Deletes the specified network security group. The group must not contain any VNICs.\n\nTo get a list of the VNICs in a network security group, use\n[ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics).\nEach returned [NetworkSecurityGroupVnic](#/en/iaas/latest/NetworkSecurityGroupVnic/) object\ncontains both the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC and the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC's parent resource (for example,\nthe Compute instance that the VNIC is attached to).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: GetNetworkSecurityGroup",
|
|
"api_call": "GET /networkSecurityGroups/{networkSecurityGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Gets the specified network security group's information.\n\nTo list the VNICs in an NSG, see\n[ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics).\n\nTo list the security rules in an NSG, see\n[ListNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/ListNetworkSecurityGroupSecurityRules).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: UpdateNetworkSecurityGroup",
|
|
"api_call": "PUT /networkSecurityGroups/{networkSecurityGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Updates the specified network security group.\n\nTo add or remove an existing VNIC from the group, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n\nTo add a VNIC to the group *when you create the VNIC*, specify the NSG's [OCID](/iaas/Content/General/Concepts/identifiers.htm) during creation.\nFor example, see the `nsgIds` attribute in [CreateVnicDetails](#/en/iaas/latest/datatypes/CreateVnicDetails).\n\nTo add or remove security rules from the group, use\n[AddNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/AddNetworkSecurityGroupSecurityRules)\nor\n[RemoveNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/RemoveNetworkSecurityGroupSecurityRules).\n\nTo edit the contents of existing security rules in the group, use\n[UpdateNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/UpdateNetworkSecurityGroupSecurityRules).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: ListNetworkSecurityGroupSecurityRules",
|
|
"api_call": "GET /networkSecurityGroups/{networkSecurityGroupId}/securityRules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"direction": "string: Direction of the security rule. Set to `EGRESS` for rules that allow outbound IP packets,\nor `INGRESS` for rules that allow inbound IP packets.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by.",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Lists the security rules in the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups > {network Security Group Id}: ListNetworkSecurityGroupVnics",
|
|
"api_call": "GET /networkSecurityGroups/{networkSecurityGroupId}/vnics",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortBy": "string: The field to sort by.",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"networkSecurityGroupId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group."
|
|
},
|
|
"functionality": "Lists the VNICs in the specified network security group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups: ListNetworkSecurityGroups",
|
|
"api_call": "GET /networkSecurityGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists either the network security groups in the specified compartment, or those associated with the specified VLAN.\nYou must specify either a `vlanId` or a `compartmentId`, but not both. If you specify a `vlanId`, all other parameters are ignored.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - network Security Groups: CreateNetworkSecurityGroup",
|
|
"api_call": "POST /networkSecurityGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new network security group for the specified VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips > {private Ip Id}: DeletePrivateIp",
|
|
"api_call": "DELETE /privateIps/{privateIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"privateIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
|
|
},
|
|
"functionality": "Unassigns and deletes the specified private IP. You must\nspecify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The private IP address is returned to\nthe subnet's pool of available addresses.\n\nThis operation cannot be used with primary private IPs, which are\nautomatically unassigned and deleted when the VNIC is terminated.\n\n**Important:** If a secondary private IP is the\n[target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),\nunassigning it from the VNIC causes that route rule to blackhole and the traffic\nwill be dropped.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips > {private Ip Id}: GetPrivateIp",
|
|
"api_call": "GET /privateIps/{privateIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"privateIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
|
|
},
|
|
"functionality": "Gets the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nAlternatively, you can get the object by using\n[ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps)\nwith the private IP address (for example, 10.0.3.3) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips > {private Ip Id}: UpdatePrivateIp",
|
|
"api_call": "PUT /privateIps/{privateIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"privateIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the private IP."
|
|
},
|
|
"functionality": "Updates the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n - Move a secondary private IP to a different VNIC in the same subnet.\n - Change the display name for a secondary private IP.\n - Change the hostname for a secondary private IP.\n\nThis operation cannot be used with primary private IPs.\nTo update the hostname for the primary IP on a VNIC, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips: ListPrivateIps",
|
|
"api_call": "GET /privateIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"ipAddress": "string: An IP address. This could be either IPv4 or IPv6, depending on the resource.\nExample: `10.0.3.3`\n",
|
|
"subnetId": "string: The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet.",
|
|
"vnicId": "string: The OCID of the VNIC.",
|
|
"vlanId": "string: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Lists the [PrivateIp](#/en/iaas/latest/PrivateIp/) objects based\non one of these filters:\n\n - Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - Both private IP address and subnet OCID: This lets\n you get a `privateIP` object based on its private IP\n address (for example, 10.0.3.3) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp)\n requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nIf you're listing all the private IPs associated with a given subnet\nor VNIC, the response includes both primary and secondary private IPs.\n\nIf you are an Oracle Cloud VMware Solution customer and have VLANs\nin your VCN, you can filter the list by VLAN [OCID](/iaas/Content/General/Concepts/identifiers.htm). See [Vlan](#/en/iaas/latest/Vlan).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - private Ips: CreatePrivateIp",
|
|
"api_call": "POST /privateIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a secondary private IP for the specified VNIC.\nFor more information about secondary private IPs, see\n[IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id} > actions: AddPublicIpPoolCapacity",
|
|
"api_call": "POST /publicIpPools/{publicIpPoolId}/actions/addCapacity",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Adds some or all of a CIDR block to a public IP pool.\n\nThe CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id} > actions: ChangePublicIpPoolCompartment",
|
|
"api_call": "POST /publicIpPools/{publicIpPoolId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Moves a public IP pool to a different compartment. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id} > actions: RemovePublicIpPoolCapacity",
|
|
"api_call": "POST /publicIpPools/{publicIpPoolId}/actions/removeCapacity",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Removes a CIDR block from the referenced public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id}: DeletePublicIpPool",
|
|
"api_call": "DELETE /publicIpPools/{publicIpPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Deletes the specified public IP pool.\nTo delete a public IP pool it must not have any active IP address allocations.\nYou must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm) when deleting an IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id}: GetPublicIpPool",
|
|
"api_call": "GET /publicIpPools/{publicIpPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Gets the specified `PublicIpPool` object. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools > {public Ip Pool Id}: UpdatePublicIpPool",
|
|
"api_call": "PUT /publicIpPools/{publicIpPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpPoolId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool."
|
|
},
|
|
"functionality": "Updates the specified public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools: ListPublicIpPools",
|
|
"api_call": "GET /publicIpPools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Lists the public IP pools in the specified compartment.\nYou can filter the list using query parameters.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ip Pools: CreatePublicIpPool",
|
|
"api_call": "POST /publicIpPools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a public IP pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > actions: GetPublicIpByIpAddress",
|
|
"api_call": "POST /publicIps/actions/getByIpAddress",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Gets the public IP based on the public IP address (for example, 203.0.113.2).\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, the service returns the public IP object with\n`lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > actions: GetPublicIpByPrivateIpId",
|
|
"api_call": "POST /publicIps/actions/getByPrivateIpId",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Gets the public IP assigned to the specified private IP. You must specify the OCID\nof the private IP. If no public IP is assigned, a 404 is returned.\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, and you provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the original private\nIP, this operation returns a 404. If you instead provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target\nprivate IP, or if you instead call\n[GetPublicIp](#/en/iaas/latest/PublicIp/GetPublicIp) or\n[GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress), the\nservice returns the public IP object with `lifecycleState` = ASSIGNING and\n`assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: DeletePublicIp",
|
|
"api_call": "DELETE /publicIps/{publicIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Unassigns and deletes the specified public IP (either ephemeral or reserved).\nYou must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). The public IP address is returned to the\nOracle Cloud Infrastructure public IP pool.\n\n**Note:** You cannot update, unassign, or delete the public IP that Oracle automatically\nassigned to an entity for you (such as a load balancer or NAT gateway). The public IP is\nautomatically deleted if the assigned entity is terminated.\n\nFor an assigned reserved public IP, the initial unassignment portion of this operation\nis asynchronous. Poll the public IP's `lifecycleState` to determine\nif the operation succeeded.\n\nIf you want to simply unassign a reserved public IP and return it to your pool\nof reserved public IPs, instead use\n[UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: GetPublicIp",
|
|
"api_call": "GET /publicIps/{publicIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Gets the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nAlternatively, you can get the object by using [GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress)\nwith the public IP address (for example, 203.0.113.2).\n\nOr you can use [GetPublicIpByPrivateIpId](#/en/iaas/latest/PublicIp/GetPublicIpByPrivateIpId)\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is assigned to.\n\n**Note:** If you're fetching a reserved public IP that is in the process of being\nmoved to a different private IP, the service returns the public IP object with\n`lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: UpdatePublicIp",
|
|
"api_call": "PUT /publicIps/{publicIpId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Updates the specified public IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). Use this operation if you want to:\n\n* Assign a reserved public IP in your pool to a private IP.\n* Move a reserved public IP to a different private IP.\n* Unassign a reserved public IP from a private IP (which returns it to your pool\nof reserved public IPs).\n* Change the display name or tags for a public IP.\n\nAssigning, moving, and unassigning a reserved public IP are asynchronous\noperations. Poll the public IP's `lifecycleState` to determine if the operation\nsucceeded.\n\n**Note:** When moving a reserved public IP, the target private IP\nmust not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it\ndoes, an error is returned. Also, the initial unassignment from the original\nprivate IP always succeeds, but the assignment to the target private IP is asynchronous and\ncould fail silently (for example, if the target private IP is deleted or has a different public IP\nassigned to it in the interim). If that occurs, the public IP remains unassigned and its\n`lifecycleState` switches to AVAILABLE (it is not reassigned to its original private IP).\nYou must poll the public IP's `lifecycleState` to determine if the move succeeded.\n\nRegarding ephemeral public IPs:\n\n* If you want to assign an ephemeral public IP to a primary private IP, use\n[CreatePublicIp](#/en/iaas/latest/PublicIp/CreatePublicIp).\n* You can't move an ephemeral public IP to a different private IP.\n* If you want to unassign an ephemeral public IP from its private IP, use\n[DeletePublicIp](#/en/iaas/latest/PublicIp/DeletePublicIp), which\nunassigns and deletes the ephemeral public IP.\n\n**Note:** If a public IP is assigned to a secondary private\nIP (see [PrivateIp](#/en/iaas/latest/PrivateIp)), and you move that secondary\nprivate IP to another VNIC, the public IP moves with it.\n\n**Note:** There's a limit to the number of [public IPs](#/en/iaas/latest/PublicIp/)\na VNIC or instance can have. If you try to move a reserved public IP\nto a VNIC or instance that has already reached its public IP limit, an error is\nreturned. For information about the public IP limits, see\n[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips > {public Ip Id}: ChangePublicIpCompartment",
|
|
"api_call": "POST /publicIps/{publicIpId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"publicIpId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the public IP."
|
|
},
|
|
"functionality": "Moves a public IP into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nThis operation applies only to reserved public IPs. Ephemeral public IPs always belong to the\nsame compartment as their VNIC and move accordingly.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips: ListPublicIps",
|
|
"api_call": "GET /publicIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"scope": "string: (Required) Whether the public IP is regional or specific to a particular availability domain.\n\n* `REGION`: The public IP exists within a region and is assigned to a regional entity\n(such as a [NatGateway](#/en/iaas/latest/NatGateway/)), or can be assigned to a private IP\nin any availability domain in the region. Reserved public IPs have `scope` = `REGION`, as do\nephemeral public IPs assigned to a regional entity.\n\n* `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity\nit's assigned to, which is specified by the `availabilityDomain` property of the public IP object.\nEphemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`.\n",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"lifetime": "string: A filter to return only public IPs that match given lifetime.\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment."
|
|
},
|
|
"functionality": "Lists the [PublicIp](#/en/iaas/latest/PublicIp/) objects\nin the specified compartment. You can filter the list by using query parameters.\n\nTo list your reserved public IPs:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `RESERVED`\n\nTo list the ephemeral public IPs assigned to a regional entity such as a NAT gateway:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `EPHEMERAL`\n\nTo list the ephemeral public IPs assigned to private IPs:\n * Set `scope` = `AVAILABILITY_DOMAIN` (required)\n * Set the `availabilityDomain` parameter to the desired availability domain (required)\n * Set `lifetime` = `EPHEMERAL`\n\n**Note:** An ephemeral public IP assigned to a private IP\nis always in the same availability domain and compartment as the private IP.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - public Ips: CreatePublicIp",
|
|
"api_call": "POST /publicIps",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a public IP. Use the `lifetime` property to specify whether it's an ephemeral or\nreserved public IP. For information about limits on how many you can create, see\n[Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm).\n\n* **For an ephemeral public IP assigned to a private IP:** You must also specify a `privateIpId`\nwith the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary private IP you want to assign the public IP to. The public IP is\ncreated in the same availability domain as the private IP. An ephemeral public IP must always be\nassigned to a private IP, and only to the *primary* private IP on a VNIC, not a secondary\nprivate IP. Exception: If you create a [NatGateway](#/en/iaas/latest/NatGateway/), Oracle\nautomatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove.\n\n* **For a reserved public IP:** You may also optionally assign the public IP to a private\nIP by specifying `privateIpId`. Or you can later assign the public IP with\n[UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp).\n\n**Note:** When assigning a public IP to a private IP, the private IP must not already have\na public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned.\n\nAlso, for reserved public IPs, the optional assignment part of this operation is\nasynchronous. Poll the public IP's `lifecycleState` to determine if the assignment\nsucceeded.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id} > actions: ChangeRemotePeeringConnectionCompartment",
|
|
"api_call": "POST /remotePeeringConnections/{remotePeeringConnectionId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id} > actions: ConnectRemotePeeringConnections",
|
|
"api_call": "POST /remotePeeringConnections/{remotePeeringConnectionId}/actions/connect",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Connects this RPC to another one in a different region.\n\nThis operation must be called by the VCN administrator who is designated as\nthe *requestor* in the peering relationship. The *acceptor* must implement\nan Identity and Access Management (IAM) policy that gives the requestor permission\nto connect to RPCs in the acceptor's compartment. Without that permission, this\noperation will fail. For more information, see\n[VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id}: DeleteRemotePeeringConnection",
|
|
"api_call": "DELETE /remotePeeringConnections/{remotePeeringConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Deletes the remote peering connection (RPC).\n\nThis is an asynchronous operation; the RPC's `lifecycleState` changes to TERMINATING temporarily\nuntil the RPC is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id}: GetRemotePeeringConnection",
|
|
"api_call": "GET /remotePeeringConnections/{remotePeeringConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Get the specified remote peering connection's information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections > {remote Peering Connection Id}: UpdateRemotePeeringConnection",
|
|
"api_call": "PUT /remotePeeringConnections/{remotePeeringConnectionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"remotePeeringConnectionId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC)."
|
|
},
|
|
"functionality": "Updates the specified remote peering connection (RPC).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections: ListRemotePeeringConnections",
|
|
"api_call": "GET /remotePeeringConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the remote peering connections (RPCs) for the specified DRG and compartment\n(the RPC's compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - remote Peering Connections: CreateRemotePeeringConnection",
|
|
"api_call": "POST /remotePeeringConnections",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new remote peering connection (RPC) for the specified DRG.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: DeleteRouteTable",
|
|
"api_call": "DELETE /routeTables/{rtId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a\nVCN's default route table.\n\nThis is an asynchronous operation. The route table's `lifecycleState` will change to TERMINATING temporarily\nuntil the route table is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: GetRouteTable",
|
|
"api_call": "GET /routeTables/{rtId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Gets the specified route table's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: UpdateRouteTable",
|
|
"api_call": "PUT /routeTables/{rtId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Updates the specified route table's display name or route rules.\nAvoid entering confidential information.\n\nNote that the `routeRules` object you provide replaces the entire existing set of rules.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables > {rt Id}: ChangeRouteTableCompartment",
|
|
"api_call": "POST /routeTables/{rtId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"rtId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the route table."
|
|
},
|
|
"functionality": "Moves a route table into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables: ListRouteTables",
|
|
"api_call": "GET /routeTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the route tables in the specified VCN and specified compartment.\nIf the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment.\nThe response includes the default route table that automatically comes with\neach VCN in the specified compartment, plus any route tables you've created.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - route Tables: CreateRouteTable",
|
|
"api_call": "POST /routeTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new route table for the specified VCN. In the request you must also include at least one route\nrule for the new route table. For information on the number of rules you can have in a route table, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For general information about route\ntables in your VCN and the types of targets you can use in route rules,\nsee [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the route\ntable to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets,\nor other Networking Service components. If you're not sure which compartment to use, put the route\ntable in the same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the route table, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: DeleteSecurityList",
|
|
"api_call": "DELETE /securityLists/{securityListId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Deletes the specified security list, but only if it's not associated with a subnet. You can't delete\na VCN's default security list.\n\nThis is an asynchronous operation. The security list's `lifecycleState` will change to TERMINATING temporarily\nuntil the security list is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: GetSecurityList",
|
|
"api_call": "GET /securityLists/{securityListId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Gets the specified security list's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: UpdateSecurityList",
|
|
"api_call": "PUT /securityLists/{securityListId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Updates the specified security list's display name or rules.\nAvoid entering confidential information.\n\nNote that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire\nexisting objects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists > {security List Id}: ChangeSecurityListCompartment",
|
|
"api_call": "POST /securityLists/{securityListId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"securityListId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the security list."
|
|
},
|
|
"functionality": "Moves a security list into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists: ListSecurityLists",
|
|
"api_call": "GET /securityLists",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the security lists in the specified VCN and compartment.\nIf the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - security Lists: CreateSecurityList",
|
|
"api_call": "POST /securityLists",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new security list for the specified VCN. For more information\nabout security lists, see [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm).\nFor information on the number of rules you can have in a security list, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the security\nlist to reside. Notice that the security list doesn't have to be in the same compartment as the VCN, subnets,\nor other Networking Service components. If you're not sure which compartment to use, put the security\nlist in the same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the security list, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id} > actions: AttachService",
|
|
"api_call": "POST /serviceGateways/{serviceGatewayId}/actions/attachService",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Adds the specified [Service](#/en/iaas/latest/Service/) to the list of enabled\n`Service` objects for the specified gateway. You must also set up a route rule with the\n`cidrBlock` of the `Service` as the rule's destination and the service gateway as the rule's\ntarget. See [Route Table](#/en/iaas/latest/RouteTable/).\n\n**Note:** The `AttachServiceId` operation is an easy way to add an individual `Service` to\nthe service gateway. Compare it with\n[UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces\nthe entire existing list of enabled `Service` objects with the list that you provide in the\n`Update` call.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id} > actions: ChangeServiceGatewayCompartment",
|
|
"api_call": "POST /serviceGateways/{serviceGatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Moves a service gateway into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id} > actions: DetachService",
|
|
"api_call": "POST /serviceGateways/{serviceGatewayId}/actions/detachService",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Removes the specified [Service](#/en/iaas/latest/Service/) from the list of enabled\n`Service` objects for the specified gateway. You do not need to remove any route\nrules that specify this `Service` object's `cidrBlock` as the destination CIDR. However, consider\nremoving the rules if your intent is to permanently disable use of the `Service` through this\nservice gateway.\n\n**Note:** The `DetachServiceId` operation is an easy way to remove an individual `Service` from\nthe service gateway. Compare it with\n[UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces\nthe entire existing list of enabled `Service` objects with the list that you provide in the\n`Update` call. `UpdateServiceGateway` also lets you block all traffic through the service\ngateway without having to remove each of the individual `Service` objects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id}: DeleteServiceGateway",
|
|
"api_call": "DELETE /serviceGateways/{serviceGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Deletes the specified service gateway. There must not be a route table that lists the service\ngateway as a target.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id}: GetServiceGateway",
|
|
"api_call": "GET /serviceGateways/{serviceGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Gets the specified service gateway's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways > {service Gateway Id}: UpdateServiceGateway",
|
|
"api_call": "PUT /serviceGateways/{serviceGatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"serviceGatewayId": "[REQUIRED] string: (Required) The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Updates the specified service gateway. The information you provide overwrites the existing\nattributes of the gateway.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways: ListServiceGateways",
|
|
"api_call": "GET /serviceGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID\nto filter the results by VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - service Gateways: CreateServiceGateway",
|
|
"api_call": "POST /serviceGateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new service gateway in the specified compartment.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want\nthe service gateway to reside. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the service gateway, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - services: ListServices",
|
|
"api_call": "GET /services",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the available [Service](#/en/iaas/latest/Service/) objects that you can enable for a\nservice gateway in this region.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - services: GetService",
|
|
"api_call": "GET /services/{serviceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"serviceId": "[REQUIRED] string: (Required) The service's [OCID](/iaas/Content/General/Concepts/identifiers.htm)."
|
|
},
|
|
"functionality": "Gets the specified [Service](#/en/iaas/latest/Service/) object.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: DeleteSubnet",
|
|
"api_call": "DELETE /subnets/{subnetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous\noperation. The subnet's `lifecycleState` will change to TERMINATING temporarily. If there are any\ninstances in the subnet, the state will instead change back to AVAILABLE.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: GetSubnet",
|
|
"api_call": "GET /subnets/{subnetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Gets the specified subnet's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: UpdateSubnet",
|
|
"api_call": "PUT /subnets/{subnetId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Updates the specified subnet.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets > {subnet Id}: ChangeSubnetCompartment",
|
|
"api_call": "POST /subnets/{subnetId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"subnetId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the subnet."
|
|
},
|
|
"functionality": "Moves a subnet into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets: ListSubnets",
|
|
"api_call": "GET /subnets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the subnets in the specified VCN and the specified compartment.\nIf the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - subnets: CreateSubnet",
|
|
"api_call": "POST /subnets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation,\nso it's important to think about the size of subnets you need before creating them.\nFor more information, see [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm).\nFor information on the number of subnets you can have in a VCN, see\n[Service Limits](/iaas/Content/General/Concepts/servicelimits.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the subnet\nto reside. Notice that the subnet doesn't have to be in the same compartment as the VCN, route tables, or\nother Networking Service components. If you're not sure which compartment to use, put the subnet in\nthe same compartment as the VCN. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs,\nsee [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally associate a route table with the subnet. If you don't, the subnet will use the\nVCN's default route table. For more information about route tables, see\n[Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n\nYou may optionally associate a security list with the subnet. If you don't, the subnet will use the\nVCN's default security list. For more information about security lists, see\n[Security Lists](/iaas/Content/Network/Concepts/securitylists.htm).\n\nYou may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the\nVCN's default set. For more information about DHCP options, see\n[DHCP Options](/iaas/Content/Network/Tasks/managingDHCP.htm).\n\nYou may optionally specify a *display name* for the subnet, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nYou can also add a DNS label for the subnet, which is required if you want the Internet and\nVCN Resolver to resolve hostnames for instances in the subnet. For more information, see\n[DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: AddVcnCidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/addCidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Adds a CIDR block to a VCN. The CIDR block you add:\n\n- Must be valid.\n- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.\n- Must not exceed the limit of CIDR blocks allowed per VCN.\n\n**Note:** Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: AddVcnIpv6Cidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/addIpv6Cidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Add an IPv6 CIDR to a VCN. The VCN size is always /56.\nAddVcnIpv6CidrDetails provides flexibility to have different private and public IPv6 address space.\nOnce added the IPv6 CIDR block cannot be removed or modified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: ChangeVcnCompartment",
|
|
"api_call": "POST /vcns/{vcnId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Moves a VCN into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: ModifyVcnCidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/modifyCidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria:\n\n- Must be valid.\n- Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.\n- Must not exceed the limit of CIDR blocks allowed per VCN.\n- Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules.\n- No IP address in an existing subnet should be outside of the new CIDR block range.\n\n**Note:** Modifying a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can vary depending on the size of your network. Updating a small network could take about a minute, and updating a large network could take up to an hour. You can use the `GetWorkRequest` operation to check the status of the update.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id} > actions: RemoveVcnCidr",
|
|
"api_call": "POST /vcns/{vcnId}/actions/removeCidr",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Removes a specified CIDR block from a VCN.\n\n**Notes:**\n- You cannot remove a CIDR block if an IP address in its range is in use.\n- Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id}: DeleteVcn",
|
|
"api_call": "DELETE /vcns/{vcnId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Deletes the specified VCN. The VCN must be empty and have no attached gateways. This is an asynchronous\noperation. The VCN's `lifecycleState` will change to TERMINATING temporarily until the VCN is completely\nremoved.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id}: GetVcn",
|
|
"api_call": "GET /vcns/{vcnId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Gets the specified VCN's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns > {vcn Id}: UpdateVcn",
|
|
"api_call": "PUT /vcns/{vcnId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vcnId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Updates the specified VCN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns: ListVcns",
|
|
"api_call": "GET /vcns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the virtual cloud networks (VCNs) in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vcns: CreateVcn",
|
|
"api_call": "POST /vcns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new virtual cloud network (VCN). For more information, see\n[VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm).\n\nFor the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria:\n\n- The CIDR blocks must be valid.\n- They must not overlap with each other or with the on-premises network CIDR block. \n- The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN.\n\nFor a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in [RFC 1918](https://tools.ietf.org/html/rfc1918) (10.0.0.0/8, 172.16/12, and 192.168/16). Example:\n172.16.0.0/16. The CIDR blocks can range from /16 to /30.\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the VCN to\nreside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which\ncompartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other\nNetworking Service components. For more information about compartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the VCN, otherwise a default is provided. It does not have to\nbe unique, and you can change it. Avoid entering confidential information.\n\nYou can also add a DNS label for the VCN, which is required if you want the instances to use the\nInterent and VCN Resolver option for DNS in the VCN. For more information, see\n[DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm).\n\nThe VCN automatically comes with a default route table, default security list, and default set of DHCP options.\nThe [OCID](/iaas/Content/General/Concepts/identifiers.htm) for each is returned in the response. You can't delete these default objects, but you can change their\ncontents (that is, change the route rules, security list rules, and so on).\n\nThe VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN\nor FastConnect. For more information, see\n[Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id} > actions: BulkAddVirtualCircuitPublicPrefixes",
|
|
"api_call": "POST /virtualCircuits/{virtualCircuitId}/actions/bulkAddPublicPrefixes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Adds one or more customer public IP prefixes to the specified public virtual circuit.\nUse this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit))\nto add prefixes to the virtual circuit. Oracle must verify the customer's ownership\nof each prefix before traffic for that prefix will flow across the virtual circuit.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id} > actions: BulkDeleteVirtualCircuitPublicPrefixes",
|
|
"api_call": "POST /virtualCircuits/{virtualCircuitId}/actions/bulkDeletePublicPrefixes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Removes one or more customer public IP prefixes from the specified public virtual circuit.\nUse this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit))\nto remove prefixes from the virtual circuit. When the virtual circuit's state switches\nback to PROVISIONED, Oracle stops advertising the specified prefixes across the connection.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id} > actions: ChangeVirtualCircuitCompartment",
|
|
"api_call": "POST /virtualCircuits/{virtualCircuitId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Moves a virtual circuit into a different compartment within the same tenancy. For information\nabout moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: DeleteVirtualCircuit",
|
|
"api_call": "DELETE /virtualCircuits/{virtualCircuitId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Deletes the specified virtual circuit.\n\n**Important:** If you're using FastConnect via a provider,\nmake sure to also terminate the connection with\nthe provider, or else the provider may continue to bill you.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: GetVirtualCircuit",
|
|
"api_call": "GET /virtualCircuits/{virtualCircuitId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Gets the specified virtual circuit's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: UpdateVirtualCircuit",
|
|
"api_call": "PUT /virtualCircuits/{virtualCircuitId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Updates the specified virtual circuit. This can be called by\neither the customer who owns the virtual circuit, or the\nprovider (when provisioning or de-provisioning the virtual\ncircuit from their end). The documentation for\n[UpdateVirtualCircuitDetails](#/en/iaas/latest/requests/UpdateVirtualCircuitDetails)\nindicates who can update each property of the virtual circuit.\n\n**Important:** If the virtual circuit is working and in the\nPROVISIONED state, updating any of the network-related properties\n(such as the DRG being used, the BGP ASN, and so on) will cause the virtual\ncircuit's state to switch to PROVISIONING and the related BGP\nsession to go down. After Oracle re-provisions the virtual circuit,\nits state will return to PROVISIONED. Make sure you confirm that\nthe associated BGP session is back up. For more information\nabout the various states and how to test connectivity, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nTo change the list of public IP prefixes for a public virtual circuit,\nuse [BulkAddVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkAddVirtualCircuitPublicPrefixes)\nand\n[BulkDeleteVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkDeleteVirtualCircuitPublicPrefixes).\nUpdating the list of prefixes does NOT cause the BGP session to go down. However,\nOracle must verify the customer's ownership of each added prefix before\ntraffic for that prefix will flow across the virtual circuit.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits > {virtual Circuit Id}: ListVirtualCircuitPublicPrefixes",
|
|
"api_call": "GET /virtualCircuits/{virtualCircuitId}/publicPrefixes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"verificationState": "string: A filter to only return resources that match the given verification\nstate.\n\nThe state value is case-insensitive.\n",
|
|
"virtualCircuitId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the virtual circuit."
|
|
},
|
|
"functionality": "Lists the public IP prefixes and their details for the specified\npublic virtual circuit.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits: ListVirtualCircuits",
|
|
"api_call": "GET /virtualCircuits",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the virtual circuits in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - virtual Circuits: CreateVirtualCircuit",
|
|
"api_call": "POST /virtualCircuits",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new virtual circuit to use with Oracle Cloud\nInfrastructure FastConnect. For more information, see\n[FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the\ncompartment where you want the virtual circuit to reside. If you're\nnot sure which compartment to use, put the virtual circuit in the\nsame compartment with the DRG it's using. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\nFor information about OCIDs, see\n[Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm).\n\nYou may optionally specify a *display name* for the virtual circuit.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\n**Important:** When creating a virtual circuit, you specify a DRG for\nthe traffic to flow through. Make sure you attach the DRG to your\nVCN and confirm the VCN's routing sends traffic to the DRG. Otherwise\ntraffic will not flow. For more information, see\n[Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: DeleteVlan",
|
|
"api_call": "DELETE /vlans/{vlanId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Deletes the specified VLAN, but only if there are no VNICs in the VLAN.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: GetVlan",
|
|
"api_call": "GET /vlans/{vlanId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Gets the specified VLAN's information.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: UpdateVlan",
|
|
"api_call": "PUT /vlans/{vlanId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Updates the specified VLAN. Note that this operation might require changes to all\nthe VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans > {vlan Id}: ChangeVlanCompartment",
|
|
"api_call": "POST /vlans/{vlanId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vlanId": "[REQUIRED] string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN."
|
|
},
|
|
"functionality": "Moves a VLAN into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans: ListVlans",
|
|
"api_call": "GET /vlans",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the VLANs in the specified VCN and the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vlans: CreateVlan",
|
|
"api_call": "POST /vlans",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a VLAN in the specified VCN and the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments > {vnic Attachment Id}: DetachVnic",
|
|
"api_call": "DELETE /vnicAttachments/{vnicAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vnicAttachmentId": "[REQUIRED] string: (Required) The OCID of the VNIC attachment."
|
|
},
|
|
"functionality": "Detaches and deletes the specified secondary VNIC.\nThis operation cannot be used on the instance's primary VNIC.\nWhen you terminate an instance, all attached VNICs (primary\nand secondary) are automatically detached and deleted.\n\n**Important:** If the VNIC has a\n[private IP](#/en/iaas/latest/PrivateIp/) that is the\n[target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip),\ndeleting the VNIC causes that route rule to blackhole and the traffic\nwill be dropped.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments > {vnic Attachment Id}: GetVnicAttachment",
|
|
"api_call": "GET /vnicAttachments/{vnicAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vnicAttachmentId": "[REQUIRED] string: (Required) The OCID of the VNIC attachment."
|
|
},
|
|
"functionality": "Gets the information for the specified VNIC attachment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments: ListVnicAttachments",
|
|
"api_call": "GET /vnicAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"vnicId": "string: The OCID of the VNIC."
|
|
},
|
|
"functionality": "Lists the VNIC attachments in the specified compartment. A VNIC attachment\nresides in the same compartment as the attached instance. The list can be\nfiltered by instance, VNIC, or availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnic Attachments: AttachVnic",
|
|
"api_call": "POST /vnicAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a secondary VNIC and attaches it to the specified instance.\nFor more information about secondary VNICs, see\n[Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnics/{vnic Id}: GetVnic",
|
|
"api_call": "GET /vnics/{vnicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"vnicId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC."
|
|
},
|
|
"functionality": "Gets the information for the specified virtual network interface card (VNIC).\nYou can get the VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm) from the\n[ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments)\noperation.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - vnics/{vnic Id}: UpdateVnic",
|
|
"api_call": "PUT /vnics/{vnicId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"vnicId": "[REQUIRED] string: (Required) The [OCID](/Content/General/Concepts/identifiers.htm) of the VNIC."
|
|
},
|
|
"functionality": "Updates the specified VNIC.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments > {volume Attachment Id}: DetachVolume",
|
|
"api_call": "DELETE /volumeAttachments/{volumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the volume attachment."
|
|
},
|
|
"functionality": "Detaches a storage volume from an instance. You must specify the OCID of the volume attachment.\n\nThis is an asynchronous operation. The attachment's `lifecycleState` will change to DETACHING temporarily\nuntil the attachment is completely removed.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments > {volume Attachment Id}: GetVolumeAttachment",
|
|
"api_call": "GET /volumeAttachments/{volumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the volume attachment."
|
|
},
|
|
"functionality": "Gets information about the specified volume attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments > {volume Attachment Id}: UpdateVolumeAttachment",
|
|
"api_call": "PUT /volumeAttachments/{volumeAttachmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeAttachmentId": "[REQUIRED] string: (Required) The OCID of the volume attachment."
|
|
},
|
|
"functionality": "Updates information about the specified volume attachment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments: ListVolumeAttachments",
|
|
"api_call": "GET /volumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"instanceId": "string: The OCID of the instance.",
|
|
"volumeId": "string: The OCID of the volume."
|
|
},
|
|
"functionality": "Lists the volume attachments in the specified compartment. You can filter the\nlist by specifying an instance OCID, volume OCID, or both.\n\nCurrently, the only supported volume attachment type are [IScsiVolumeAttachment](#/en/iaas/latest/IScsiVolumeAttachment/) and\n[ParavirtualizedVolumeAttachment](#/en/iaas/latest/ParavirtualizedVolumeAttachment/).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Attachments: AttachVolume",
|
|
"api_call": "POST /volumeAttachments/",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Attaches the specified storage volume to the specified instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies > {policy Id}: DeleteVolumeBackupPolicy",
|
|
"api_call": "DELETE /volumeBackupPolicies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the volume backup policy."
|
|
},
|
|
"functionality": "Deletes a user defined backup policy.\n For more information about user defined backup policies,\n see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies).\n\n Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies > {policy Id}: GetVolumeBackupPolicy",
|
|
"api_call": "GET /volumeBackupPolicies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the volume backup policy."
|
|
},
|
|
"functionality": "Gets information for the specified volume backup policy.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies > {policy Id}: UpdateVolumeBackupPolicy",
|
|
"api_call": "PUT /volumeBackupPolicies/{policyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"policyId": "[REQUIRED] string: (Required) The OCID of the volume backup policy."
|
|
},
|
|
"functionality": "Updates a user defined backup policy.\n For more information about user defined backup policies,\n see [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm#UserDefinedBackupPolicies).\n\n Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies: ListVolumeBackupPolicies",
|
|
"api_call": "GET /volumeBackupPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"compartmentId": "string: The OCID of the compartment.\nIf no compartment is specified, the Oracle defined backup policies are listed.\n"
|
|
},
|
|
"functionality": "Lists all the volume backup policies available in the specified compartment.\n\nFor more information about Oracle defined backup policies and user defined backup policies,\nsee [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policies: CreateVolumeBackupPolicy",
|
|
"api_call": "POST /volumeBackupPolicies",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new user defined backup policy.\n\nFor more information about Oracle defined backup policies and user defined backup policies,\nsee [Policy-Based Backups](/iaas/Content/Block/Tasks/schedulingvolumebackups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments > {policy Assignment Id}: DeleteVolumeBackupPolicyAssignment",
|
|
"api_call": "DELETE /volumeBackupPolicyAssignments/{policyAssignmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyAssignmentId": "[REQUIRED] string: (Required) The OCID of the volume backup policy assignment."
|
|
},
|
|
"functionality": "Deletes a volume backup policy assignment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments > {policy Assignment Id}: GetVolumeBackupPolicyAssignment",
|
|
"api_call": "GET /volumeBackupPolicyAssignments/{policyAssignmentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"policyAssignmentId": "[REQUIRED] string: (Required) The OCID of the volume backup policy assignment."
|
|
},
|
|
"functionality": "Gets information for the specified volume backup policy assignment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments: GetVolumeBackupPolicyAssetAssignment",
|
|
"api_call": "GET /volumeBackupPolicyAssignments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"assetId": "string: (Required) The OCID of an asset (e.g. a volume).",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Gets the volume backup policy assignment for the specified volume. The\n`assetId` query parameter is required, and the returned list will contain at most\none item, since volume can only have one volume backup policy assigned at a time.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backup Policy Assignments: CreateVolumeBackupPolicyAssignment",
|
|
"api_call": "POST /volumeBackupPolicyAssignments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Assigns a volume backup policy to the specified volume. Note that a given volume can\nonly have one backup policy assigned to it. If this operation is used for a volume that already\nhas a different backup policy assigned, the prior backup policy will be silently unassigned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id} > actions: ChangeVolumeBackupCompartment",
|
|
"api_call": "POST /volumeBackups/{volumeBackupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Moves a volume backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id} > actions: CreateVolumeBackupCopy",
|
|
"api_call": "POST /volumeBackups/{volumeBackupId}/actions/copy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Creates a volume backup copy in specified region. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id}: DeleteVolumeBackup",
|
|
"api_call": "DELETE /volumeBackups/{volumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Deletes a volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id}: GetVolumeBackup",
|
|
"api_call": "GET /volumeBackups/{volumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Gets information for the specified volume backup.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups > {volume Backup Id}: UpdateVolumeBackup",
|
|
"api_call": "PUT /volumeBackups/{volumeBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeBackupId": "[REQUIRED] string: (Required) The OCID of the volume backup."
|
|
},
|
|
"functionality": "Updates the display name for the specified volume backup.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups: ListVolumeBackups",
|
|
"api_call": "GET /volumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the volume backups in the specified compartment. You can filter the results by volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Backups: CreateVolumeBackup",
|
|
"api_call": "POST /volumeBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new backup of the specified volume. For general information about volume backups,\nsee [Overview of Block Volume Service Backups](/iaas/Content/Block/Concepts/blockvolumebackups.htm)\n\nWhen the request is received, the backup object is in a REQUEST_RECEIVED state.\nWhen the data is imaged, it goes into a CREATING state.\nAfter the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id} > actions: ChangeVolumeGroupBackupCompartment",
|
|
"api_call": "POST /volumeGroupBackups/{volumeGroupBackupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Moves a volume group backup into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id} > actions: CreateVolumeGroupBackupCopy",
|
|
"api_call": "POST /volumeGroupBackups/{volumeGroupBackupId}/actions/copy",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Creates a volume group backup copy in specified region. For general information about volume group backups,\nsee [Overview of Block Volume Service Backups](/Content/Block/Concepts/blockvolumebackups.htm)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id}: DeleteVolumeGroupBackup",
|
|
"api_call": "DELETE /volumeGroupBackups/{volumeGroupBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Deletes a volume group backup. This operation deletes all the backups in\nthe volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id}: GetVolumeGroupBackup",
|
|
"api_call": "GET /volumeGroupBackups/{volumeGroupBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Gets information for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups > {volume Group Backup Id}: UpdateVolumeGroupBackup",
|
|
"api_call": "PUT /volumeGroupBackups/{volumeGroupBackupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupBackupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group backup.\n"
|
|
},
|
|
"functionality": "Updates the display name for the specified volume group backup. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups: ListVolumeGroupBackups",
|
|
"api_call": "GET /volumeGroupBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"volumeGroupId": "string: The OCID of the volume group.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the volume group backups in the specified compartment. You can filter the results by volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Group Backups: CreateVolumeGroupBackup",
|
|
"api_call": "POST /volumeGroupBackups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new backup volume group of the specified volume group.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: DeleteVolumeGroup",
|
|
"api_call": "DELETE /volumeGroups/{volumeGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Deletes the specified volume group. Individual volumes are not deleted, only the volume group is deleted.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: GetVolumeGroup",
|
|
"api_call": "GET /volumeGroups/{volumeGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Gets information for the specified volume group. For more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: UpdateVolumeGroup",
|
|
"api_call": "PUT /volumeGroups/{volumeGroupId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Updates the set of volumes in a volume group along with the display name. Use this operation\nto add or remove volumes in a volume group. Specify the full list of volume IDs to include in the\nvolume group. If the volume ID is not specified in the call, it will be removed from the volume group.\nAvoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups > {volume Group Id}: ChangeVolumeGroupCompartment",
|
|
"api_call": "POST /volumeGroups/{volumeGroupId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeGroupId": "[REQUIRED] string: (Required) The Oracle Cloud ID (OCID) that uniquely identifies the volume group."
|
|
},
|
|
"functionality": "Moves a volume group into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups: ListVolumeGroups",
|
|
"api_call": "GET /volumeGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n",
|
|
"lifecycleState": "string: A filter to only return resources that match the given lifecycle\nstate. The state value is case-insensitive.\n"
|
|
},
|
|
"functionality": "Lists the volume groups in the specified compartment and availability domain.\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volume Groups: CreateVolumeGroup",
|
|
"api_call": "POST /volumeGroups",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new volume group in the specified compartment.\nA volume group is a collection of volumes and may be created from a list of volumes, cloning an existing\nvolume group, or by restoring a volume group backup.\nYou may optionally specify a *display name* for the volume group, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n\nFor more information, see [Volume Groups](/iaas/Content/Block/Concepts/volumegroups.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id} > kms Key: DeleteVolumeKmsKey",
|
|
"api_call": "DELETE /volumes/{volumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Removes the specified volume's assigned Key Management encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id} > kms Key: GetVolumeKmsKey",
|
|
"api_call": "GET /volumes/{volumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Gets the Key Management encryption key assigned to the specified volume.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id} > kms Key: UpdateVolumeKmsKey",
|
|
"api_call": "PUT /volumes/{volumeId}/kmsKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Updates the specified volume with a new Key Management master encryption key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: DeleteVolume",
|
|
"api_call": "DELETE /volumes/{volumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Deletes the specified volume. The volume cannot have an active connection to an instance.\nTo disconnect the volume from a connected instance, see\n[Disconnecting From a Volume](/iaas/Content/Block/Tasks/disconnectingfromavolume.htm).\n**Warning:** All data on the volume will be permanently lost when the volume is deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: GetVolume",
|
|
"api_call": "GET /volumes/{volumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Gets information for the specified volume.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: UpdateVolume",
|
|
"api_call": "PUT /volumes/{volumeId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`\nparameter to the value of the etag from a previous GET or POST response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Updates the specified volume's display name.\nAvoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes > {volume Id}: ChangeVolumeCompartment",
|
|
"api_call": "POST /volumes/{volumeId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"volumeId": "[REQUIRED] string: (Required) The OCID of the volume."
|
|
},
|
|
"functionality": "Moves a volume into a different compartment within the same tenancy.\nFor information about moving resources between compartments,\nsee [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes: ListVolumes",
|
|
"api_call": "GET /volumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the volumes in the specified compartment and availability domain.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - volumes: CreateVolume",
|
|
"api_call": "POST /volumes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations (for example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmay be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new volume in the specified compartment. Volumes can be created in sizes ranging from\n50 GB (51200 MB) to 32 TB (33554432 MB), in 1 GB (1024 MB) increments. By default, volumes are 1 TB (1048576 MB).\nFor general information about block volumes, see\n[Overview of Block Volume Service](/iaas/Content/Block/Concepts/overview.htm).\n\nA volume and instance can be in separate compartments but must be in the same availability domain.\nFor information about access control and compartments, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about\navailability domains, see [Regions and Availability Domains](/iaas/Content/General/Concepts/regions.htm).\nTo get a list of availability domains, use the `ListAvailabilityDomains` operation\nin the Identity and Access Management Service API.\n\nYou may optionally specify a *display name* for the volume, which is simply a friendly name or\ndescription. It does not have to be unique, and you can change it. Avoid entering confidential information.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListAllowedPeerRegionsForRemotePeering",
|
|
"api_call": "GET /allowedPeerRegionsForRemotePeering",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header"
|
|
},
|
|
"functionality": "Lists the regions that support remote VCN peering (which is peering across regions).\nFor more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListComputeCapacityReservationInstanceShapes",
|
|
"api_call": "GET /computeCapacityReservationInstanceShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"sortBy": "string: The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by availability domain if the scope of the resource type is within a\nsingle availability domain. If you call one of these \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domain, then sorted.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order\nis case sensitive.\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be reserved within the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListCrossConnectLocations",
|
|
"api_call": "GET /crossConnectLocations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the available FastConnect locations for cross-connect installation. You need\nthis information so you can specify your desired location when you create a cross-connect.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListCrossConnectPortSpeedShapes",
|
|
"api_call": "GET /crossConnectPortSpeedShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the available port speeds for cross-connects. You need this information\nso you can specify your desired port speed (that is, shape) when you create a\ncross-connect.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListDedicatedVmHostInstanceShapes",
|
|
"api_call": "GET /dedicatedVmHostInstanceShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"dedicatedVmHostShape": "string: Dedicated VM host shape name\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be used to launch a virtual machine instance on a dedicated virtual machine host within the specified compartment.\nYou can filter the list by compatibility with a specific dedicated virtual machine host shape.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListDedicatedVmHostShapes",
|
|
"api_call": "GET /dedicatedVmHostShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"availabilityDomain": "string: The name of the availability domain.\n\nExample: `Uocm:PHX-AD-1`\n",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"instanceShapeName": "string: The name for the instance's shape.\n",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n",
|
|
"page": "string: For list pagination. The value of the `opc-next-page` response header from the previous \"List\"\ncall. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be used to launch a dedicated virtual machine host within the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: Get a Virtual Networking topology for the current region",
|
|
"api_call": "GET /networkingTopology",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-none-match": "string: For querying if there is a cached value on the server. The If-None-Match HTTP request header \nmakes the request conditional. For GET and HEAD methods, the server will send back the requested \nresource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nFor other methods, the request will be processed only if the eventually existing resource's \nETag doesn't match any of the values listed.\n",
|
|
"cache-control": "string: The Cache-Control HTTP header holds directives (instructions)\nfor caching in both requests and responses.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"accessLevel": "string: Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`.\nSetting this to `ACCESSIBLE` returns only compartments for which a\nuser has INSPECT permissions, either directly or indirectly (permissions can be on a\nresource in a subcompartment). A restricted set of fields is returned for compartments in which a user has\nindirect INSPECT permissions.\n\nWhen set to `ANY` permissions are not checked.\n",
|
|
"queryCompartmentSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand the specified compartment and its subcompartments are\ninspected depending on the the setting of `accessLevel`.\nDefault is false.\n"
|
|
},
|
|
"functionality": "Gets a virtual networking topology for the current region.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListShapes",
|
|
"api_call": "GET /shapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "Lists the shapes that can be used to launch an instance within the specified compartment. You can\nfilter the list by compatibility with a specific image.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: Get Virtual Network VCN topology",
|
|
"api_call": "GET /vcnTopology",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.\nIf you need to contact Oracle about a particular request, please provide the request ID.\n",
|
|
"if-none-match": "string: For querying if there is a cached value on the server. The If-None-Match HTTP request header \nmakes the request conditional. For GET and HEAD methods, the server will send back the requested \nresource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nFor other methods, the request will be processed only if the eventually existing resource's \nETag doesn't match any of the values listed.\n",
|
|
"cache-control": "string: The Cache-Control HTTP header holds directives (instructions)\nfor caching in both requests and responses.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"accessLevel": "string: Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`.\nSetting this to `ACCESSIBLE` returns only compartments for which a\nuser has INSPECT permissions, either directly or indirectly (permissions can be on a\nresource in a subcompartment). A restricted set of fields is returned for compartments in which a user has\nindirect INSPECT permissions.\n\nWhen set to `ANY` permissions are not checked.\n",
|
|
"queryCompartmentSubtree": "boolean: When set to true, the hierarchy of compartments is traversed\nand the specified compartment and its subcompartments are\ninspected depending on the the setting of `accessLevel`.\nDefault is false.\n",
|
|
"vcnId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN."
|
|
},
|
|
"functionality": "Gets a virtual network topology for a given VCN.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Core Services API - General: ListVirtualCircuitBandwidthShapes",
|
|
"api_call": "GET /virtualCircuitBandwidthShapes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment.",
|
|
"limit": "integer: For list pagination. The maximum number of results per page, or items to return in a paginated\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n\nExample: `50`\n"
|
|
},
|
|
"functionality": "The deprecated operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > versions: Lists all secret versions for a secret.",
|
|
"api_call": "GET /secrets/{secretId}/versions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"limit": "string: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"page": "string: The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Time created is default ordered as descending. Display name is default ordered as ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists all secret versions for the specified secret.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > version > {secretVersionNumber} > actions > scheduleDeletion: Schedules a deletion of a secret version.",
|
|
"api_call": "POST /secrets/{secretId}/version/{secretVersionNumber}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string",
|
|
"secretVersionNumber": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only\ndelete a secret version if the secret version rotation state is marked as `DEPRECATED`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > version > {secretVersionNumber} > actions > cancelDeletion: Cancels a scheduled secret version deletion.",
|
|
"api_call": "POST /secrets/{secretId}/version/{secretVersionNumber}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string",
|
|
"secretVersionNumber": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of a secret version.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > version > {secretVersionNumber}: Gets details about a secret version.",
|
|
"api_call": "GET /secrets/{secretId}/version/{secretVersionNumber}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string",
|
|
"secretVersionNumber": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified version of a secret.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > actions > scheduleDeletion: Schedules the deletion of a secret.",
|
|
"api_call": "POST /secrets/{secretId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified secret. This sets the lifecycle state of the secret\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > actions > changeCompartment: Moves a secret into a different compartment.",
|
|
"api_call": "POST /secrets/{secretId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Moves a secret into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the secret.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > actions > cancelDeletion: Cancels a scheduled secret deletion.",
|
|
"api_call": "POST /secrets/{secretId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the pending deletion of the specified secret. Canceling\na scheduled deletion restores the secret's lifecycle state to what\nit was before you scheduled the secret for deletion.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId}: Gets details about a secret.",
|
|
"api_call": "GET /secrets/{secretId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified secret.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId}: Updates a secret's properties.",
|
|
"api_call": "PUT /secrets/{secretId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the properties of a secret. Specifically, you can update the version number of the secret to make\nthat version number the current version. You can also update a secret's description, its free-form or defined tags, rules\nand the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the\nsame time. Furthermore, the secret must in an `ACTIVE` lifecycle state to be updated.\n\nThis operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets: Lists all secrets.",
|
|
"api_call": "GET /secrets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default order for\n`TIMECREATED` is descending. The default order for `NAME` is ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
|
|
},
|
|
"functionality": "Lists all secrets in the specified vault and compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets: Creates a secret.",
|
|
"api_call": "POST /secrets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new secret according to the details of the request.\n\nThis operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get API",
|
|
"api_call": "GET /apis/{apiId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Gets an API by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Update the API by the identifier",
|
|
"api_call": "PUT /apis/{apiId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Updates the API with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Delete an API.",
|
|
"api_call": "DELETE /apis/{apiId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Deletes the API with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Change the API compartment.",
|
|
"api_call": "POST /apis/{apiId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Changes the API compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get raw API content",
|
|
"api_call": "GET /apis/{apiId}/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"range": "string: The Range HTTP request header indicates the part of a document that the\nserver should return. [RFC 7233](https://tools.ietf.org/html/rfc7233#section-3.1).\nNote that only a single range of bytes is supported.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Get the raw API content.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get API Deployment specification based on the API.",
|
|
"api_call": "GET /apis/{apiId}/deploymentSpecification",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Gets an API Deployment specification by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis > {api Id}: Get API content",
|
|
"api_call": "GET /apis/{apiId}/validations",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"apiId": "[REQUIRED] string: (Required) The ocid of the API."
|
|
},
|
|
"functionality": "Gets the API validation results.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis: Gets a list of all APIs in a compartment",
|
|
"api_call": "GET /apis",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of APIs.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - apis: Creates a new API",
|
|
"api_call": "POST /apis",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new API.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Get Certificate",
|
|
"api_call": "GET /certificates/{certificateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Gets a certificate by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Update Certificate by the identifier",
|
|
"api_call": "PUT /certificates/{certificateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Updates a certificate with the given identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Delete a provisioned Certificate",
|
|
"api_call": "DELETE /certificates/{certificateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Deletes the certificate with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates > {certificate Id}: Change the certificate compartment.",
|
|
"api_call": "POST /certificates/{certificateId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"certificateId": "[REQUIRED] string: (Required) The ocid of the certificate."
|
|
},
|
|
"functionality": "Changes the certificate compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates: Gets a list of all Certificates in a compartment",
|
|
"api_call": "GET /certificates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE` or `DELETED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of certificates.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - certificates: Creates a new Certificate",
|
|
"api_call": "POST /certificates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new Certificate.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Get Deployment",
|
|
"api_call": "GET /deployments/{deploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Gets a deployment by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Update the Deployment identified by the id",
|
|
"api_call": "PUT /deployments/{deploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Updates the deployment with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Delete a provisioned Deployment",
|
|
"api_call": "DELETE /deployments/{deploymentId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Deletes the deployment with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments > {deployment Id}: Change the deployment compartment.",
|
|
"api_call": "POST /deployments/{deploymentId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"deploymentId": "[REQUIRED] string: (Required) The ocid of the deployment."
|
|
},
|
|
"functionality": "Changes the deployment compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments: Gets a list of all Deployments in a compartment",
|
|
"api_call": "GET /deployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `SUCCEEDED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of deployments.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - deployments: Creates a new Deployment",
|
|
"api_call": "POST /deployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new deployment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Get Gateway",
|
|
"api_call": "GET /gateways/{gatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Gets a gateway by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Update the Gateway by the identifier",
|
|
"api_call": "PUT /gateways/{gatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Updates the gateway with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Delete a provisioned Gateway",
|
|
"api_call": "DELETE /gateways/{gatewayId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Deletes the gateway with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways > {gateway Id}: Change the gateway compartment.",
|
|
"api_call": "POST /gateways/{gatewayId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"gatewayId": "[REQUIRED] string: (Required) The ocid of the gateway."
|
|
},
|
|
"functionality": "Changes the gateway compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways: Gets a list of all Gateways in a compartment",
|
|
"api_call": "GET /gateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `SUCCEEDED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Returns a list of gateways.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - gateways: Creates a new Gateway",
|
|
"api_call": "POST /gateways",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new gateway.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks > {sdk Id}: Downloadable link for the SDK.",
|
|
"api_call": "GET /sdks/{sdkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"sdkId": "[REQUIRED] string: (Required) The ocid of the SDK."
|
|
},
|
|
"functionality": "Return object store downloadable URL and metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks > {sdk Id}: Update the SDK by the identifier",
|
|
"api_call": "PUT /sdks/{sdkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"sdkId": "[REQUIRED] string: (Required) The ocid of the SDK."
|
|
},
|
|
"functionality": "Updates the SDK with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks > {sdk Id}: Deletes SDK",
|
|
"api_call": "DELETE /sdks/{sdkId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"sdkId": "[REQUIRED] string: (Required) The ocid of the SDK."
|
|
},
|
|
"functionality": "Deletes provided SDK.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks: Lists SDKs",
|
|
"api_call": "GET /sdks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"sdkId": "string: The ocid of the SDK.",
|
|
"displayName": "string: A user-friendly name. Does not have to be unique, and it's changeable.\n\nExample: `My new resource`\n",
|
|
"lifecycleState": "string: A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE` or `DELETED`\n",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"page": "string: 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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n",
|
|
"apiId": "string: The ocid of the API."
|
|
},
|
|
"functionality": "Returns list of generated SDKs.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - sdks: Creates an SDK",
|
|
"api_call": "POST /sdks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a new SDK.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Gets work request status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Cancel the work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Cancels the work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Returns a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ocid of the asynchronous request."
|
|
},
|
|
"functionality": "Returns a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - work Requests: List work requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources.",
|
|
"resourceId": "string: Filter work requests by the resource ocid.",
|
|
"page": "string: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"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`).\nDefault order for `timeCreated` is descending. Default order for\n`displayName` is ascending. The `displayName` sort order is case\nsensitive.\n"
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: API Gateway API - General: Lists available SDK target languages.",
|
|
"api_call": "GET /sdkLanguageTypes",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request id for tracing.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The ocid of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists programming languages in which SDK can be generated.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Document Understanding API - processor Jobs > {processor Job Id}: Get the details of a processor job.",
|
|
"api_call": "GET /processorJobs/{processorJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"processorJobId": "[REQUIRED] string: (Required) Processor job id."
|
|
},
|
|
"functionality": "Get the details of a processor job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Document Understanding API - processor Jobs > {processor Job Id}: Cancel a processor job.",
|
|
"api_call": "POST /processorJobs/{processorJobId}/actions/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"processorJobId": "[REQUIRED] string: (Required) Processor job id."
|
|
},
|
|
"functionality": "Cancel a processor job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Document Understanding API - processor Jobs: Create a processor job for document analysis.",
|
|
"api_call": "POST /processorJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without the risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a processor job for document analysis.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Gets a connectharness",
|
|
"api_call": "GET /connectharnesses/{connectHarnessId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Gets detailed information about a connect harness.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Updates a connect harness.",
|
|
"api_call": "PUT /connectharnesses/{connectHarnessId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Updates the tags applied to the connect harness.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Deletes a connect harness.",
|
|
"api_call": "DELETE /connectharnesses/{connectHarnessId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion.\nThe `lifecycleState` parameter of the `ConnectHarness` object changes to `DELETING` and the connect harness becomes inaccessible for read or write operations.\nTo verify that a connect harness has been deleted, make a [GetConnectHarness](https://docs.oracle.com/iaas/api/#/en/streaming/20180418/ConnectHarness/GetConnectHarness) request. If the call returns the connect harness's\nlifecycle state as `DELETED`, then the connect harness has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the\nconnect harness have been deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /connectharnesses/{connectHarnessId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: 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.",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses: Lists the connectharnesses.",
|
|
"api_call": "GET /connectharnesses",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"limit": "integer: The maximum number of items to return. The value must be between 1 and 50. The default is 10.",
|
|
"sortBy": "string: The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.\n"
|
|
},
|
|
"functionality": "Lists the connectharness.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses: Create a connect harness",
|
|
"api_call": "POST /connectharnesses",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: 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 may be rejected).",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Starts the provisioning of a new connect harness.\nTo track the progress of the provisioning, you can periodically call [GetConnectHarness].\nIn the response, the `lifecycleState` parameter of the [ConnectHarness](https://docs.oracle.com/iaas/api/#/en/streaming/20180418/ConnectHarness/) object tells you its current state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Gets the stream pool",
|
|
"api_call": "GET /streampools/{streamPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Gets detailed information about the stream pool, such as Kafka settings.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Updates the stream pool.",
|
|
"api_call": "PUT /streampools/{streamPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Updates the specified stream pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Deletes a stream pool.",
|
|
"api_call": "DELETE /streampools/{streamPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Deletes a stream pool. All containing streams will also be deleted.\nThe default stream pool of a compartment cannot be deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /streampools/{streamPoolId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: 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.",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools: List the stream pools for a given compartment ID.",
|
|
"api_call": "GET /streampools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"limit": "integer: The maximum number of items to return. The value must be between 1 and 50. The default is 10.",
|
|
"sortBy": "string: The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.\n"
|
|
},
|
|
"functionality": "List the stream pools for a given compartment ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools: Creates a stream pool.",
|
|
"api_call": "POST /streampools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: 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 may be rejected).",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Starts the provisioning of a new stream pool.\nTo track the progress of the provisioning, you can periodically call GetStreamPool.\nIn the response, the `lifecycleState` parameter of the object tells you its current state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > groups/{group Name}: Returns the current state of a consumer group.",
|
|
"api_call": "GET /streams/{streamId}/groups/{groupName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n",
|
|
"groupName": "[REQUIRED] string: (Required) The name of the consumer group."
|
|
},
|
|
"functionality": "Returns the current state of a consumer group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > groups/{group Name}: Forcefully changes the committed location of a group on a stream.",
|
|
"api_call": "PUT /streams/{streamId}/groups/{groupName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n",
|
|
"groupName": "[REQUIRED] string: (Required) The name of the consumer group."
|
|
},
|
|
"functionality": "Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > messages: Gets messages from a stream.",
|
|
"api_call": "GET /streams/{streamId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cursor": "string: (Required) The cursor used to consume the stream.\n",
|
|
"limit": "integer: The maximum number of messages to return. You can specify any value up to 10000. By default, the service returns as many messages as possible.\nConsider your average message size to help avoid exceeding throughput on the stream.\n",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Returns messages from the specified stream using the specified cursor as the starting point for consumption. By default, the number of messages returned is undefined, but the service returns as many as possible.\nTo get messages, you must first obtain a cursor using the [CreateCursor](https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/Cursor/CreateCursor) operation.\nIn the response, retrieve the value of the 'opc-next-cursor' header to pass as a parameter to get the next batch of messages in the stream.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > messages: Puts messages in a stream.",
|
|
"api_call": "POST /streams/{streamId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Emits messages to a stream. There's no limit to the number of messages in a request, but the total size of a message or request must be 1 MiB or less.\nThe service calculates the partition ID from the message key and stores messages that share a key on the same partition.\nIf a message does not contain a key or if the key is null, the service generates a message key for you.\nThe partition ID cannot be passed as a parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Gets a stream",
|
|
"api_call": "GET /streams/{streamId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Gets detailed information about a stream, including the number of partitions.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Updates a stream.",
|
|
"api_call": "PUT /streams/{streamId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Updates the stream. Only specified values will be updated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Deletes a stream.",
|
|
"api_call": "DELETE /streams/{streamId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Deletes a stream and its content. Stream contents are deleted immediately. The service retains records of the stream itself for 90 days after deletion.\nThe `lifecycleState` parameter of the `Stream` object changes to `DELETING` and the stream becomes inaccessible for read or write operations.\nTo verify that a stream has been deleted, make a [GetStream](https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/Stream/GetStream) request. If the call returns the stream's\nlifecycle state as `DELETED`, then the stream has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the\nstream have been deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /streams/{streamId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: 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.",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Moves a resource into a different compartment.\nWhen provided, If-Match is checked against ETag values of the resource.\nThe stream will also be moved into the default stream pool in the destination compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Commits processed offsets to consumer group state.",
|
|
"api_call": "POST /streams/{streamId}/commit",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cursor": "string: (Required) The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.\n",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics.\nThis commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Creates a cursor for the specified stream. A cursor is used to consume a stream.",
|
|
"api_call": "POST /streams/{streamId}/cursors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Creates a cursor. Cursors are used to consume a stream, starting from a specific point in the partition and going forward from there.\nYou can create a cursor based on an offset, a time, the trim horizon, or the most recent message in the stream. As the oldest message\ninside the retention period boundary, using the trim horizon effectively lets you consume all messages in the stream. A cursor based\non the most recent message allows consumption of only messages that are added to the stream after you create the cursor. Cursors expire\nfive minutes after you receive them from the service.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Creates a group-cursor for the specified stream. A cursor is used to consume a stream.",
|
|
"api_call": "POST /streams/{streamId}/groupCursors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Creates a group-cursor.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Extends the reservation timeout on partitions reserved by the provided cursor.",
|
|
"api_call": "POST /streams/{streamId}/heartbeat",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cursor": "string: (Required) The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.\n",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams: Lists the streams in the given compartment id.",
|
|
"api_call": "GET /streams",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required.",
|
|
"limit": "integer: The maximum number of items to return. The value must be between 1 and 50. The default is 10.",
|
|
"sortBy": "string: The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.\n"
|
|
},
|
|
"functionality": "Lists the streams in the given compartment id.\nIf the compartment id is specified, it will list streams in the compartment, regardless of their stream pool.\nIf the stream pool id is specified, the action will be scoped to that stream pool.\nThe compartment id and stream pool id cannot be specified at the same time.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams: Creates a stream.",
|
|
"api_call": "POST /streams",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Starts the provisioning of a new stream.\nThe stream will be created in the given compartment id or stream pool id, depending on which parameter is specified.\nCompartment id and stream pool id cannot be specified at the same time.\nTo track the progress of the provisioning, you can periodically call [GetStream](https://docs.oracle.com/iaas/api/#/en/streaming/20180418/Stream/GetStream).\nIn the response, the `lifecycleState` parameter of the [Stream](https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/Stream/) object tells you its current state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests > {workRequestId} > logs: Get work request logs.",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Get the logs of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests > {workRequestId} > errors: Get work request errors.",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Get the errors of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests > {workRequestId}: Get Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > stop: Stop an integration instance that was previously in an ACTIVE state",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Stop an integration instance that was previously in an ACTIVE state\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > start: Start an integration instance that was previously in an INACTIVE state",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Start an integration instance that was previously in an INACTIVE state\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > changeNetworkEndpoint: Change an Integration instance network endpoint.",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/changeNetworkEndpoint",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Change an Integration instance network endpoint. The operation is long-running\nand creates a new WorkRequest.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > changeCompartment: Change the compartment for an integration instance",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Change the compartment for an integration instance\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId}: Delete a provisioned Integration Instance",
|
|
"api_call": "DELETE /integrationInstances/{integrationInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Deletes an Integration Instance resource by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId}: Get Integration Instance",
|
|
"api_call": "GET /integrationInstances/{integrationInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets a IntegrationInstance by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId}: Update the Integration Instance identified by the id",
|
|
"api_call": "PUT /integrationInstances/{integrationInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the Integration Instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances: Gets a list of all Integration Instances in a compartment",
|
|
"api_call": "GET /integrationInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order\nfor TIMECREATED is descending. Default order for DISPLAYNAME is\nascending. If no value is specified TIMECREATED is default.\n"
|
|
},
|
|
"functionality": "Returns a list of Integration Instances.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances: Creates a new Integration Instance",
|
|
"api_call": "POST /integrationInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new Integration Instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > actions: Moves a resource into a different compartment.",
|
|
"api_call": "POST /queues/{queueId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Moves a queue from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > actions: Deletes all messages present in the queue at the time of invocation.",
|
|
"api_call": "POST /queues/{queueId}/actions/purge",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Deletes all messages present in the queue at the time of invocation. Only one concurrent purge operation is supported for any given queue.\nHowever multiple concurrent purge operations are supported for different queues.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > actions: Deletes multiple messages from the queue.",
|
|
"api_call": "POST /20210201/queues/{queueId}/messages/actions/deleteMessages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Deletes multiple messages from the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > actions: Updates multiple messages in the queue.",
|
|
"api_call": "POST /20210201/queues/{queueId}/messages/actions/updateMessages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Updates multiple messages in the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > {message Receipt}: Deletes a message from the queue.",
|
|
"api_call": "DELETE /20210201/queues/{queueId}/messages/{messageReceipt}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier.",
|
|
"messageReceipt": "[REQUIRED] string: (Required) The receipt of the message retrieved from a GetMessages call."
|
|
},
|
|
"functionality": "Deletes the message represented by the receipt from the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > {message Receipt}: Updates the visibility of a message to extend (or reduce) it.",
|
|
"api_call": "PUT /20210201/queues/{queueId}/messages/{messageReceipt}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier.",
|
|
"messageReceipt": "[REQUIRED] string: (Required) The receipt of the message retrieved from a GetMessages call."
|
|
},
|
|
"functionality": "Updates the visibility of the message represented by the receipt.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages: Consumes message from the queue.",
|
|
"api_call": "GET /20210201/queues/{queueId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Consumes messages from the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages: Puts messages in the queue.",
|
|
"api_call": "POST /20210201/queues/{queueId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Puts messages into the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Delete a provisioned Queue",
|
|
"api_call": "DELETE /queues/{queueId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Deletes a queue resource by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Get Queue",
|
|
"api_call": "GET /queues/{queueId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Gets a queue by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Update the Queue identified by the id",
|
|
"api_call": "PUT /queues/{queueId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Updates the specified queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Gets the statistics for the queue and its dead letter queue.",
|
|
"api_call": "GET /20210201/queues/{queueId}/stats",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Gets the statistics for the queue and its dead letter queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues: Gets a list of all Queues in a compartment",
|
|
"api_call": "GET /queues",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Returns a list of queues.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues: Creates a new Queue",
|
|
"api_call": "POST /queues",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new queue.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests > {work Request Id}: GET Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine)."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Gets the properties of the specified configuration source provider.",
|
|
"api_call": "GET /configurationSourceProviders/{configurationSourceProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Gets the properties of the specified configuration source provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Updates the properties of the specified configuration source provider.",
|
|
"api_call": "PUT /configurationSourceProviders/{configurationSourceProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Updates the properties of the specified configuration source provider.\nFor more information, see\n[To edit a configuration source provider](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingconfigurationsourceproviders.htm#EditConfigurationSourceProvider).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Deletes the specified configuration source provider.",
|
|
"api_call": "DELETE /configurationSourceProviders/{configurationSourceProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Deletes the specified configuration source provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Moves a ConfigurationSourceProvider into a different compartment. When provided, If-Match is checked against ETag values of the ConfigurationSourceProvider.",
|
|
"api_call": "POST /configurationSourceProviders/{configurationSourceProviderId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Moves a configuration source provider into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers: Lists configuration source providers.",
|
|
"api_call": "GET /configurationSourceProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"configurationSourceProviderId": "string: A filter to return only configuration source providers that match the provided [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list a resource by name.\nRequires `sortBy` set to `DISPLAYNAME`.\nAlternatively, when you know the resource OCID, use the related Get operation.\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"configSourceProviderType": "string: A filter to return only configuration source providers of the specified type (GitHub or GitLab).\n"
|
|
},
|
|
"functionality": "Lists configuration source providers according to the specified filter.\n- For `compartmentId`, lists all configuration source providers in the matching compartment.\n- For `configurationSourceProviderId`, lists the matching configuration source provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers: Creates a configuration source provider in the specified compartment.",
|
|
"api_call": "POST /configurationSourceProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a configuration source provider in the specified compartment.\nFor more information, see\n[To create a configuration source provider](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingconfigurationsourceproviders.htm#CreateConfigurationSourceProvider).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id} > logs: Gets log entries for a job",
|
|
"api_call": "GET /jobs/{jobId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.",
|
|
"type": "string: A filter that returns only logs of a specified type.\n",
|
|
"levelGreaterThanOrEqualTo": "string: A filter that returns only log entries that match a given severity level or greater.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"timestampGreaterThanOrEqualTo": "number: Time stamp specifying the lower time limit for which logs are returned in a query.\nFormat is defined by RFC3339.\nExample: `2020-01-01T12:00:00.000Z`\n",
|
|
"timestampLessThanOrEqualTo": "number: Time stamp specifying the upper time limit for which logs are returned in a query.\nFormat is defined by RFC3339.\nExample: `2020-02-01T12:00:00.000Z`\n"
|
|
},
|
|
"functionality": "Returns console log entries for the specified job in JSON format.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id} > logs: Gets the raw logs for a job.",
|
|
"api_call": "GET /jobs/{jobId}/logs/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns a raw log file for the specified job. The raw log file contains console log entries in text format. The maximum number of entries in a file is 100,000.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Get details of a specific job.",
|
|
"api_call": "GET /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the specified job along with the job details.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Update a Job.",
|
|
"api_call": "PUT /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Updates the specified job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Cancel a Job",
|
|
"api_call": "DELETE /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"isForced": "boolean: Indicates whether a forced cancellation is requested for the job while it was running.\nA forced cancellation can result in an incorrect state file.\nFor example, the state file might not reflect the exact state of the provisioned resources.\n",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Indicates the intention to cancel the specified job.\nCancellation of the job is not immediate, and may be delayed,\nor may not happen at all.\nYou can optionally choose forced cancellation by setting `isForced` to true.\nA forced cancellation can result in an incorrect state file.\nFor example, the state file might not reflect the exact state of the provisioned resources.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Gets job detailed log content.",
|
|
"api_call": "GET /jobs/{jobId}/detailedLogContent",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the Terraform detailed log content for the specified job in plain text. [Learn about Terraform detailed log.](https://www.terraform.io/docs/internals/debugging.html)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Get zipped Terraform configuration used for a specific job.",
|
|
"api_call": "GET /jobs/{jobId}/tfConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the Terraform configuration file for the specified job in .zip format.\nReturns an error if no zip file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Get Terraform state output from a specified job.",
|
|
"api_call": "GET /jobs/{jobId}/tfState",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the Terraform state for the specified job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs: List all jobs related to a stack or compartment. By default, the list is ordered by time created.\nYou can alter the ordering by using `SortByQueryParam` and `SortOrderQueryParam`.\n",
|
|
"api_call": "GET /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"stackId": "string: The stack [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) on which to filter.\n",
|
|
"id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) on which to query for jobs.\n",
|
|
"lifecycleState": "string: A filter that returns all resources that match the specified lifecycle state.\nThe state value is case-insensitive.\n\nAllowable values:\n- ACCEPTED\n- IN_PROGRESS\n- FAILED\n- SUCCEEDED\n- CANCELING\n- CANCELED\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list a resource by name.\nRequires `sortBy` set to `DISPLAYNAME`.\nAlternatively, when you know the resource OCID, use the related Get operation.\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "integer: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Returns a list of jobs in a stack or compartment, ordered by time created.\n\n- To list all jobs in a stack, provide the stack [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n- To list all jobs in a compartment, provide the compartment [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n- To return a specific job, provide the job [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs: Create a Job.",
|
|
"api_call": "POST /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id} > actions: Moves a Stack and it's associated Jobs into a different compartment. When provided, If-Match is checked against ETag values of the Stack.",
|
|
"api_call": "POST /stacks/{stackId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Moves a Stack and it's associated Jobs into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id} > actions: Checks drift status for the specified stack.\n",
|
|
"api_call": "POST /stacks/{stackId}/actions/detectDrift",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Checks drift status for the specified stack.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id} > actions: Lists drift status details for each resource defined in the specified stack.",
|
|
"api_call": "POST /stacks/{stackId}/actions/listResourceDriftDetails",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"workRequestId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.",
|
|
"resourceDriftStatus": "string: A filter that returns only resources that match the given drift status. The value is case-insensitive.\nAllowable values -\n - NOT_CHECKED\n - MODIFIED\n - IN_SYNC\n - DELETED\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Lists drift status details for each resource defined in the specified stack.\nThe drift status details for a given resource indicate differences, if any, between the actual state\nand the expected (defined) state for that resource.\nThe drift status details correspond to the specified work request (`workRequestId`).\nIf no work request is specified, then the drift status details correspond to the latest completed work request for the stack.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Gets a stack by ID.",
|
|
"api_call": "GET /stacks/{stackId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Gets a stack using the stack ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Updates the specified stack object.",
|
|
"api_call": "PUT /stacks/{stackId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Updates the specified stack object.\nUse `UpdateStack` when you update your Terraform configuration\nand want your changes to be reflected in the execution plan.\nFor more information, see\n[To update a stack](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingstacksandjobs.htm#UpdateStack) and\n[To edit a stack](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingstacksandjobs.htm#EditStack).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Deletes a stack",
|
|
"api_call": "DELETE /stacks/{stackId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Deletes the specified stack object.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Gets the stack's zipped Terraform configuration",
|
|
"api_call": "GET /stacks/{stackId}/tfConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Returns the Terraform configuration file in .zip format for the specified stack.\nReturns an error if no zip file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Get Terraform state of the specified stack.",
|
|
"api_call": "GET /stacks/{stackId}/tfState",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Returns the Terraform state for the specified stack.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks: Returns a stack or list of stacks.",
|
|
"api_call": "GET /stacks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Returns a list of stacks.\n- If called using the compartment ID, returns all stacks in the specified compartment.\n- If called using the stack ID, returns the specified stack.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks: Creates a Stack.",
|
|
"api_call": "POST /stacks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a stack in the specified compartment.\nYou can create a stack from a Terraform configuration.\nThe Terraform configuration can be directly uploaded or referenced from a source code control system.\nYou can also create a stack from an existing compartment.\nYou can also upload the Terraform configuration from an Object Storage bucket.\nFor more information, see\n[To create a stack](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingstacksandjobs.htm#createstack-all).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Gets the specified template.",
|
|
"api_call": "GET /templates/{templateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Gets the specified template.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Updates the specified template.",
|
|
"api_call": "PUT /templates/{templateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Updates the specified template.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Deletes the specified template.",
|
|
"api_call": "DELETE /templates/{templateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Deletes the specified template.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Moves a template into a different compartment. When provided, If-Match is checked against ETag values of the Template.",
|
|
"api_call": "POST /templates/{templateId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Moves a template into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Gets the template's logo file",
|
|
"api_call": "GET /templates/{templateId}/logo",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Returns the Terraform logo file in .logo format for the specified template.\nReturns an error if no logo file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Gets the template's zipped Terraform configuration",
|
|
"api_call": "GET /templates/{templateId}/tfConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Returns the Terraform configuration file in .zip format for the specified template.\nReturns an error if no zip file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates: Lists templates according to the specified filter.",
|
|
"api_call": "GET /templates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"templateCategoryId": "string: Unique identifier of the template category.\nPossible values are `0` (Quick Starts), `1` (Service), `2` (Architecture), and `3` (Private).\n",
|
|
"templateId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list a resource by name.\nRequires `sortBy` set to `DISPLAYNAME`.\nAlternatively, when you know the resource OCID, use the related Get operation.\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists templates according to the specified filter.\nThe attributes `compartmentId` and `templateCategoryId` are required unless `templateId` is specified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates: Creates a private template in the specified compartment.",
|
|
"api_call": "POST /templates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a private template in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests > {work Request Id}: Get Work Request",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Return the given work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests: Lists work requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"resourceId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the work requests in a given compartment or for a given resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - General: Lists supported Resource Discovery services.",
|
|
"api_call": "GET /resourceDiscoveryServices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n"
|
|
},
|
|
"functionality": "Returns a list of supported services for Resource Discovery. For reference on service names, see the [Terraform provider documentation](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - General: Lists template categories.",
|
|
"api_call": "GET /templateCategories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header"
|
|
},
|
|
"functionality": "Lists template categories.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - General: Lists supported Terraform versions.",
|
|
"api_call": "GET /terraformVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n"
|
|
},
|
|
"functionality": "Returns a list of supported Terraform versions for use with stacks.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Gets a connectharness",
|
|
"api_call": "GET /connectharnesses/{connectHarnessId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Gets detailed information about a connect harness.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Updates a connect harness.",
|
|
"api_call": "PUT /connectharnesses/{connectHarnessId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Updates the tags applied to the connect harness.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Deletes a connect harness.",
|
|
"api_call": "DELETE /connectharnesses/{connectHarnessId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion.\nThe `lifecycleState` parameter of the `ConnectHarness` object changes to `DELETING` and the connect harness becomes inaccessible for read or write operations.\nTo verify that a connect harness has been deleted, make a [GetConnectHarness](https://docs.oracle.com/iaas/api/#/en/streaming/20180418/ConnectHarness/GetConnectHarness) request. If the call returns the connect harness's\nlifecycle state as `DELETED`, then the connect harness has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the\nconnect harness have been deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /connectharnesses/{connectHarnessId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: 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.",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses: Lists the connectharnesses.",
|
|
"api_call": "GET /connectharnesses",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"limit": "integer: The maximum number of items to return. The value must be between 1 and 50. The default is 10.",
|
|
"sortBy": "string: The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.\n"
|
|
},
|
|
"functionality": "Lists the connectharness.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses: Create a connect harness",
|
|
"api_call": "POST /connectharnesses",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: 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 may be rejected).",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Starts the provisioning of a new connect harness.\nTo track the progress of the provisioning, you can periodically call [GetConnectHarness].\nIn the response, the `lifecycleState` parameter of the [ConnectHarness](https://docs.oracle.com/iaas/api/#/en/streaming/20180418/ConnectHarness/) object tells you its current state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Gets the stream pool",
|
|
"api_call": "GET /streampools/{streamPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Gets detailed information about the stream pool, such as Kafka settings.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Updates the stream pool.",
|
|
"api_call": "PUT /streampools/{streamPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Updates the specified stream pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Deletes a stream pool.",
|
|
"api_call": "DELETE /streampools/{streamPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Deletes a stream pool. All containing streams will also be deleted.\nThe default stream pool of a compartment cannot be deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /streampools/{streamPoolId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: 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.",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools: List the stream pools for a given compartment ID.",
|
|
"api_call": "GET /streampools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"limit": "integer: The maximum number of items to return. The value must be between 1 and 50. The default is 10.",
|
|
"sortBy": "string: The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.\n"
|
|
},
|
|
"functionality": "List the stream pools for a given compartment ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools: Creates a stream pool.",
|
|
"api_call": "POST /streampools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: 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 may be rejected).",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Starts the provisioning of a new stream pool.\nTo track the progress of the provisioning, you can periodically call GetStreamPool.\nIn the response, the `lifecycleState` parameter of the object tells you its current state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > groups/{group Name}: Returns the current state of a consumer group.",
|
|
"api_call": "GET /streams/{streamId}/groups/{groupName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n",
|
|
"groupName": "[REQUIRED] string: (Required) The name of the consumer group."
|
|
},
|
|
"functionality": "Returns the current state of a consumer group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > groups/{group Name}: Forcefully changes the committed location of a group on a stream.",
|
|
"api_call": "PUT /streams/{streamId}/groups/{groupName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n",
|
|
"groupName": "[REQUIRED] string: (Required) The name of the consumer group."
|
|
},
|
|
"functionality": "Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > messages: Gets messages from a stream.",
|
|
"api_call": "GET /streams/{streamId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cursor": "string: (Required) The cursor used to consume the stream.\n",
|
|
"limit": "integer: The maximum number of messages to return. You can specify any value up to 10000. By default, the service returns as many messages as possible.\nConsider your average message size to help avoid exceeding throughput on the stream.\n",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Returns messages from the specified stream using the specified cursor as the starting point for consumption. By default, the number of messages returned is undefined, but the service returns as many as possible.\nTo get messages, you must first obtain a cursor using the [CreateCursor](https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/Cursor/CreateCursor) operation.\nIn the response, retrieve the value of the 'opc-next-cursor' header to pass as a parameter to get the next batch of messages in the stream.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > messages: Puts messages in a stream.",
|
|
"api_call": "POST /streams/{streamId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Emits messages to a stream. There's no limit to the number of messages in a request, but the total size of a message or request must be 1 MiB or less.\nThe service calculates the partition ID from the message key and stores messages that share a key on the same partition.\nIf a message does not contain a key or if the key is null, the service generates a message key for you.\nThe partition ID cannot be passed as a parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Gets a stream",
|
|
"api_call": "GET /streams/{streamId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Gets detailed information about a stream, including the number of partitions.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Updates a stream.",
|
|
"api_call": "PUT /streams/{streamId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Updates the stream. Only specified values will be updated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Deletes a stream.",
|
|
"api_call": "DELETE /streams/{streamId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Deletes a stream and its content. Stream contents are deleted immediately. The service retains records of the stream itself for 90 days after deletion.\nThe `lifecycleState` parameter of the `Stream` object changes to `DELETING` and the stream becomes inaccessible for read or write operations.\nTo verify that a stream has been deleted, make a [GetStream](https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/Stream/GetStream) request. If the call returns the stream's\nlifecycle state as `DELETED`, then the stream has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the\nstream have been deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /streams/{streamId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: 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.",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Moves a resource into a different compartment.\nWhen provided, If-Match is checked against ETag values of the resource.\nThe stream will also be moved into the default stream pool in the destination compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Commits processed offsets to consumer group state.",
|
|
"api_call": "POST /streams/{streamId}/commit",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cursor": "string: (Required) The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.\n",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics.\nThis commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Creates a cursor for the specified stream. A cursor is used to consume a stream.",
|
|
"api_call": "POST /streams/{streamId}/cursors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Creates a cursor. Cursors are used to consume a stream, starting from a specific point in the partition and going forward from there.\nYou can create a cursor based on an offset, a time, the trim horizon, or the most recent message in the stream. As the oldest message\ninside the retention period boundary, using the trim horizon effectively lets you consume all messages in the stream. A cursor based\non the most recent message allows consumption of only messages that are added to the stream after you create the cursor. Cursors expire\nfive minutes after you receive them from the service.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Creates a group-cursor for the specified stream. A cursor is used to consume a stream.",
|
|
"api_call": "POST /streams/{streamId}/groupCursors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Creates a group-cursor.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Extends the reservation timeout on partitions reserved by the provided cursor.",
|
|
"api_call": "POST /streams/{streamId}/heartbeat",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cursor": "string: (Required) The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.\n",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams: Lists the streams in the given compartment id.",
|
|
"api_call": "GET /streams",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required.",
|
|
"limit": "integer: The maximum number of items to return. The value must be between 1 and 50. The default is 10.",
|
|
"sortBy": "string: The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.\n"
|
|
},
|
|
"functionality": "Lists the streams in the given compartment id.\nIf the compartment id is specified, it will list streams in the compartment, regardless of their stream pool.\nIf the stream pool id is specified, the action will be scoped to that stream pool.\nThe compartment id and stream pool id cannot be specified at the same time.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams: Creates a stream.",
|
|
"api_call": "POST /streams",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Starts the provisioning of a new stream.\nThe stream will be created in the given compartment id or stream pool id, depending on which parameter is specified.\nCompartment id and stream pool id cannot be specified at the same time.\nTo track the progress of the provisioning, you can periodically call [GetStream](https://docs.oracle.com/iaas/api/#/en/streaming/20180418/Stream/GetStream).\nIn the response, the `lifecycleState` parameter of the [Stream](https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/Stream/) object tells you its current state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables > {custom Table Id}: Returns saved custom table.",
|
|
"api_call": "GET /customTables/{customTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"customTableId": "[REQUIRED] string: (Required) The custom table unique OCID."
|
|
},
|
|
"functionality": "Returns the saved custom table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables > {custom Table Id}: Update a custom table.",
|
|
"api_call": "PUT /customTables/{customTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"customTableId": "[REQUIRED] string: (Required) The custom table unique OCID."
|
|
},
|
|
"functionality": "Update a saved custom table by table ID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables > {custom Table Id}: Delete a custom table.",
|
|
"api_call": "DELETE /customTables/{customTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"customTableId": "[REQUIRED] string: (Required) The custom table unique OCID."
|
|
},
|
|
"functionality": "Delete a saved custom table by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables: Returns saved custom tables.",
|
|
"api_call": "GET /customTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"compartmentId": "string: (Required) The compartment ID in which to list resources.",
|
|
"savedReportId": "string: (Required) The saved report ID in which to list resources.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is displayName.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the saved custom table list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables: Create a custom table.",
|
|
"api_call": "POST /customTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error, without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Returns the created custom table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries > {query Id}: Returns saved query.",
|
|
"api_call": "GET /queries/{queryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"queryId": "[REQUIRED] string: (Required) The query unique OCID."
|
|
},
|
|
"functionality": "Returns the saved query.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries > {query Id}: Update a query.",
|
|
"api_call": "PUT /queries/{queryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queryId": "[REQUIRED] string: (Required) The query unique OCID."
|
|
},
|
|
"functionality": "Update a saved query by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries > {query Id}: Delete a query.",
|
|
"api_call": "DELETE /queries/{queryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"queryId": "[REQUIRED] string: (Required) The query unique OCID."
|
|
},
|
|
"functionality": "Delete a saved query by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries: Returns saved queries and UI properties.",
|
|
"api_call": "GET /queries",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"compartmentId": "string: (Required) The compartment ID in which to list resources.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is displayName.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the saved query list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries: Create a query.",
|
|
"api_call": "POST /queries",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error, without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Returns the created query.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - scheduled Runs: Returns schedule history list.",
|
|
"api_call": "GET /scheduledRuns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"scheduleId": "string: (Required) The schedule unique ID.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is timeCreated.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the schedule history list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - scheduled Runs: Returns saved schedule run.",
|
|
"api_call": "GET /scheduledRuns/{scheduledRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"scheduledRunId": "[REQUIRED] string: (Required) The scheduled run unique OCID."
|
|
},
|
|
"functionality": "Returns the saved schedule run.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules > {schedule Id}: Returns saved schedule.",
|
|
"api_call": "GET /schedules/{scheduleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"scheduleId": "[REQUIRED] string: (Required) The schedule unique OCID."
|
|
},
|
|
"functionality": "Returns the saved schedule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules > {schedule Id}: Update schedule.",
|
|
"api_call": "PUT /schedules/{scheduleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"scheduleId": "[REQUIRED] string: (Required) The schedule unique OCID."
|
|
},
|
|
"functionality": "Update a saved schedule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules > {schedule Id}: Delete a schedule.",
|
|
"api_call": "DELETE /schedules/{scheduleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"scheduleId": "[REQUIRED] string: (Required) The schedule unique OCID."
|
|
},
|
|
"functionality": "Delete a saved scheduled report by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules: Returns the saved schedule list.",
|
|
"api_call": "GET /schedules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The compartment ID in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is timeCreated.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the saved schedule list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules: Create a schedule.",
|
|
"api_call": "POST /schedules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error, without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Returns the created schedule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - General: Returns configurations.",
|
|
"api_call": "GET /configuration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"tenantId": "string: (Required) tenant id"
|
|
},
|
|
"functionality": "Returns the configurations list for the UI drop-down list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - General: Returns usage for the given account.",
|
|
"api_call": "POST /usage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Returns usage for the given account.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > verify: Verifies signed data by using the given VerifyDataDetails resource.",
|
|
"api_call": "POST /20180608/verify",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Verifies a digital signature that was generated by the [Sign](https://docs.oracle.com/iaas/api/#/en/key/latest/SignedData/Sign) operation\nby using the public key of the same asymmetric key that was used to sign the data. If you want to validate the\ndigital signature outside of the service, you can do so by using the public key of the asymmetric key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > usage: Gets the specified vault's usage against service limits.",
|
|
"api_call": "GET /20180608/vaults/{vaultId}/usage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets the count of keys and key versions in the specified vault to calculate usage against service limits.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > scheduleDeletion: Schedules the deletion of a vault.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it\nthat are not already scheduled for deletion to `PENDING_DELETION` and then deletes them after the\nretention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won't\nchange. If any keys in the vault are scheduled to be deleted after the specified time of\ndeletion for the vault, the call is rejected with the error code 409.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > listReplicas: Lists the replicas for a vault",
|
|
"api_call": "GET /20180608/vaults/{vaultId}/actions/listReplicas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists the replicas for a vault\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > deleteReplica: Deletes a vault replica",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/deleteReplica",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Deletes a vault replica\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > createReplica: Creates a replica for the vault in another region in the same realm",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/createReplica",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Creates a replica for the vault in another region in the same realm\n\nThe API is a no-op if called for same region that a vault is already replicated to.\n409 if called on a vault that is already replicated to a different region. Users need to delete\nexisting replica first before calling it with a different region.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > changeCompartment: Moves a vault into a different compartment.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Moves a vault into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the resource.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > cancelDeletion: Cancels the scheduled deletion of a vault.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion\nrestores the vault and all keys in it to their respective states from before their\nscheduled deletion. All keys that were scheduled for deletion prior to vault\ndeletion retain their lifecycle state and time of deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > backup: Backs up a vault.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/backup",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later.\nYou can backup a vault whether or not it contains keys. This operation only backs up the\nmetadata of the vault, and does not include key metadata.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId}: Gets details about a vault.",
|
|
"api_call": "GET /20180608/vaults/{vaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets the specified vault's configuration information.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId}: Updates the properties of a vault.",
|
|
"api_call": "PUT /20180608/vaults/{vaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the properties of a vault. Specifically, you can update the\n`displayName`, `freeformTags`, and `definedTags` properties. Furthermore,\nthe vault must be in an ACTIVE or CREATING state to be updated.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > actions > restoreFromObjectStore: Restores a vault from an object storage location.",
|
|
"api_call": "POST /20180608/vaults/actions/restoreFromObjectStore",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Restores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object\nStorage. If a vault with the same OCID already exists, this operation returns\na response with a 409 HTTP status error code.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > actions > restoreFromFile: Restores a vault from an encrypted backup file.",
|
|
"api_call": "POST /20180608/vaults/actions/restoreFromFile",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"content-md5": "string: The base64-encoded MD5 hash value of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15.\nIf the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5\nhash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and\na response with 400 Unmatched Content MD5 error is returned, along with the message: \"The computed MD5 of the request body (ACTUAL_MD5)\ndoes not match the Content-MD5 header (HEADER_MD5).\"\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Restores a vault from an encrypted backup file. If a vault\nwith the same OCID already exists, this operation returns a response with a\n409 HTTP status error code.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults: Lists vaults in the compartment.",
|
|
"api_call": "GET /20180608/vaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
|
|
},
|
|
"functionality": "Lists the vaults in the specified compartment.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults: Creates a new vault.",
|
|
"api_call": "POST /20180608/vaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new vault. The type of vault you create determines key placement, pricing, and\navailable options. Options include storage isolation, a dedicated service endpoint instead\nof a shared service endpoint for API calls, and either a dedicated hardware security module\n(HSM) or a multitenant HSM.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > sign: Signs data by using the given SignDataDetails resource.",
|
|
"api_call": "POST /20180608/sign",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a digital signature for a message or message digest by using the private key of a public-private key pair,\nalso known as an asymmetric key. To verify the generated signature, you can use the [Verify](https://docs.oracle.com/iaas/api/#/en/key/latest/VerifiedData/Verify)\noperation. Or, if you want to validate the signature outside of the service, you can do so by using the public key of the same asymmetric key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > replicaOperations > {replicationId} > status: Gets the replication status of a replica operation",
|
|
"api_call": "GET /20180608/replicaOperations/{replicationId}/status",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"replicationId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "When a vault has a replica, each operation on the vault or its resources, such as\nkeys, is replicated and has an associated replicationId. Replication status provides\ndetails about whether the operation associated with the given replicationId has been\nsuccessfully applied across replicas.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > {keyVersionId} > actions > scheduleDeletion: Schedules the deletion of a key version.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string",
|
|
"keyVersionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified key version. This sets the lifecycle state of the key version\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > {keyVersionId} > actions > cancelDeletion: Cancels the scheduled deletion of a key version.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string",
|
|
"keyVersionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of the specified key version. Canceling\na scheduled deletion restores the key version to its lifecycle state from\nbefore its scheduled deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > {keyVersionId}: Gets details about a key version.",
|
|
"api_call": "GET /20180608/keys/{keyId}/keyVersions/{keyVersionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string",
|
|
"keyVersionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified key version.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > import: Imports the given wrapped key material and then rotate the key to begin using the new key version for the specified key.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions/import",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Imports AES key material to create a new key version and then rotate the key to begin using the new\nkey version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key\nbefore you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes.\nFurthermore, the key length must match the length of the specified key and what you specify as the length\nat the time of import. When importing an asymmetric key, only the private key must be wrapped in PKCS8 format \nwhile the corresponding public key is generated internally by KMS.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions: Lists all key versions for a key.",
|
|
"api_call": "GET /20180608/keys/{keyId}/keyVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"limit": "string: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"page": "string: The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists all [KeyVersion](https://docs.oracle.com/iaas/api/#/en/key/latest/KeyVersion/) resources for the specified\nmaster encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions: Creates a new key version resource and rotates the key to use it for encryption.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Generates a new [KeyVersion](https://docs.oracle.com/iaas/api/#/en/key/latest/KeyVersion/) resource that provides new cryptographic\nmaterial for a master encryption key. The key must be in an `ENABLED` state to be rotated.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > scheduleDeletion: Schedules the deletion of a key.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified key. This sets the lifecycle state of the key\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > enable: Enables a key so it can be used for cryptographic operations.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/enable",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Enables a master encryption key so it can be used for encryption, decryption, or\ngenerating new data encryption keys.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > disable: Disables a key so it cannot be used for cryptographic operations.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/disable",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Disables a master encryption key so it can no longer be used for encryption, decryption, or\ngenerating new data encryption keys.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > changeCompartment: Moves a key into a different compartment.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Moves a key into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the key.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > cancelDeletion: Cancels the scheduled deletion of a key.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of the specified key. Canceling\na scheduled deletion restores the key's lifecycle state to what\nit was before its scheduled deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > backup: Backs up the key and associated key metadata.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/backup",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore\nthe key later. The file also contains the metadata of the vault that the key belonged to.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId}: Gets details about a key.",
|
|
"api_call": "GET /20180608/keys/{keyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified master encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second for\na given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId}: Updates a key's properties.",
|
|
"api_call": "PUT /20180608/keys/{keyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the properties of a master encryption key. Specifically, you can update the\n`displayName`, `freeformTags`, and `definedTags` properties. Furthermore,\nthe key must be in an `ENABLED` or `CREATING` state to be updated.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > import: Imports the given wrapped AES key.",
|
|
"api_call": "POST /20180608/keys/import",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Imports AES and RSA keys to create a new key. The key material must be base64-encoded \nand wrapped by the vault's public RSA wrapping key before you can import it. \nKey Management supports both RSA and AES keys. The AES keys are symmetric keys \nof length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). \nFurthermore, the key length must match what you specify at the time of import. When importing an asymmetric key, \nonly private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > actions > restoreFromObjectStore: Restores a key to a vault from an object storage location.",
|
|
"api_call": "POST /20180608/keys/actions/restoreFromObjectStore",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Restores the specified key to the specified vault from an Oracle Cloud Infrastructure\nObject Storage location. If the vault doesn't exist, the operation returns a response with a\n404 HTTP status error code. You need to first restore the vault associated with the key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > actions > restoreFromFile: Restores a key to a vault from a file.",
|
|
"api_call": "POST /20180608/keys/actions/restoreFromFile",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"content-md5": "string: The base64-encoded MD5 hash value of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15.\nIf the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5\nhash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and\na response with 400 Unmatched Content MD5 error is returned, along with the message: \"The computed MD5 of the request body (ACTUAL_MD5)\ndoes not match the Content-MD5 header (HEADER_MD5).\"\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Restores the specified key to the specified vault, based on information in the backup file provided.\nIf the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You\nneed to first restore the vault associated with the key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys: Lists keys in the specified vault and compartment.",
|
|
"api_call": "GET /20180608/keys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
|
|
},
|
|
"functionality": "Lists the master encryption keys in the specified vault and compartment.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys: Creates a new key.",
|
|
"api_call": "POST /20180608/keys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new master encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total\nnumber of requests across all management write operations. Key Management might throttle this call\nto reject an otherwise valid request when the total rate of management write operations exceeds 10\nrequests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > generateDataEncryptionKey: GenerateDataEncryptionKey",
|
|
"api_call": "POST /20180608/generateDataEncryptionKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Generates a key that you can use to encrypt or decrypt data.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > exportKey: Exports a master encryption key.",
|
|
"api_call": "POST /20180608/exportKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Exports a specific version of a master encryption key according to the details of the request. For their protection,\nkeys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys\nstored on the server. For export, the key version is encrypted by an RSA public key that you provide.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > encrypt: Encrypt",
|
|
"api_call": "POST /20180608/encrypt",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Encrypts data using the given [EncryptDataDetails](https://docs.oracle.com/iaas/api/#/en/key/latest/datatypes/EncryptDataDetails) resource.\nPlaintext included in the example request is a base64-encoded value of a UTF-8 string.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > decrypt: Decrypt",
|
|
"api_call": "POST /20180608/decrypt",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Decrypts data using the given [DecryptDataDetails](https://docs.oracle.com/iaas/api/#/en/key/latest/datatypes/DecryptDataDetails) resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > wrappingKeys: Gets details about the RSA wrapping key associated with the vault.",
|
|
"api_call": "GET /20180608/wrappingKeys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and\nunwraps AES key material for import into Key Management.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > versions: Lists all secret versions for a secret.",
|
|
"api_call": "GET /secrets/{secretId}/versions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"limit": "string: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"page": "string: The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Time created is default ordered as descending. Display name is default ordered as ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists all secret versions for the specified secret.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > version > {secretVersionNumber} > actions > scheduleDeletion: Schedules a deletion of a secret version.",
|
|
"api_call": "POST /secrets/{secretId}/version/{secretVersionNumber}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string",
|
|
"secretVersionNumber": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only\ndelete a secret version if the secret version rotation state is marked as `DEPRECATED`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > version > {secretVersionNumber} > actions > cancelDeletion: Cancels a scheduled secret version deletion.",
|
|
"api_call": "POST /secrets/{secretId}/version/{secretVersionNumber}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string",
|
|
"secretVersionNumber": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of a secret version.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > version > {secretVersionNumber}: Gets details about a secret version.",
|
|
"api_call": "GET /secrets/{secretId}/version/{secretVersionNumber}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string",
|
|
"secretVersionNumber": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified version of a secret.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > actions > scheduleDeletion: Schedules the deletion of a secret.",
|
|
"api_call": "POST /secrets/{secretId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified secret. This sets the lifecycle state of the secret\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > actions > changeCompartment: Moves a secret into a different compartment.",
|
|
"api_call": "POST /secrets/{secretId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Moves a secret into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the secret.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > actions > cancelDeletion: Cancels a scheduled secret deletion.",
|
|
"api_call": "POST /secrets/{secretId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the pending deletion of the specified secret. Canceling\na scheduled deletion restores the secret's lifecycle state to what\nit was before you scheduled the secret for deletion.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId}: Gets details about a secret.",
|
|
"api_call": "GET /secrets/{secretId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified secret.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId}: Updates a secret's properties.",
|
|
"api_call": "PUT /secrets/{secretId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the properties of a secret. Specifically, you can update the version number of the secret to make\nthat version number the current version. You can also update a secret's description, its free-form or defined tags, rules\nand the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the\nsame time. Furthermore, the secret must in an `ACTIVE` lifecycle state to be updated.\n\nThis operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets: Lists all secrets.",
|
|
"api_call": "GET /secrets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default order for\n`TIMECREATED` is descending. The default order for `NAME` is ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
|
|
},
|
|
"functionality": "Lists all secrets in the specified vault and compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets: Creates a secret.",
|
|
"api_call": "POST /secrets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new secret according to the details of the request.\n\nThis operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Retrieval API - secretbundles > {secretId} > versions: Lists all secret bundle versions.",
|
|
"api_call": "GET /secretbundles/{secretId}/versions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#List_Pagination).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call. For information about\npagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#List_Pagination).\n",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `VERSION_NUMBER` is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists all secret bundle versions for the specified secret.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Retrieval API - secretbundles > {secretId}: Gets a secret bundle.",
|
|
"api_call": "GET /secretbundles/{secretId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.",
|
|
"Accept": "string",
|
|
"versionNumber": "integer: The version number of the secret.",
|
|
"secretVersionName": "string: The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.)",
|
|
"stage": "string: The rotation state of the secret version.",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets a secret bundle that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter.\nIf none of these parameters are provided, the bundle for the secret version marked as `CURRENT` will be returned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Retrieval API - secretbundles > actions > getByName: Gets a secret bundle by secret name and vault ID.",
|
|
"api_call": "POST /secretbundles/actions/getByName",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.",
|
|
"Accept": "string",
|
|
"secretName": "string: (Required) A user-friendly name for the secret. Secret names are unique within a vault. Secret names are case-sensitive.",
|
|
"vaultId": "string: (Required) The OCID of the vault that contains the secret.",
|
|
"versionNumber": "integer: The version number of the secret.",
|
|
"secretVersionName": "string: The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.)",
|
|
"stage": "string: The rotation state of the secret version."
|
|
},
|
|
"functionality": "Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter.\nIf none of these parameters are provided, the bundle for the secret version marked as `CURRENT` is returned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - actions: Perform document analysis",
|
|
"api_call": "POST /actions/analyzeDocument",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Perform different types of image analysis.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - actions: Perform image analysis",
|
|
"api_call": "POST /actions/analyzeImage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Perform different types of image analysis.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - document Jobs > {document Job Id}: Get details of a batch document job",
|
|
"api_call": "GET /documentJobs/{documentJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"documentJobId": "[REQUIRED] string: (Required) Document job id."
|
|
},
|
|
"functionality": "Get details of a batch document job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - document Jobs > {document Job Id}: Cancel a batch document job.",
|
|
"api_call": "POST /documentJobs/{documentJobId}/actions/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"documentJobId": "[REQUIRED] string: (Required) Document job id."
|
|
},
|
|
"functionality": "Cancel a batch document job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - document Jobs: Create a batch document analysis job",
|
|
"api_call": "POST /documentJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a batch document analysis job\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - image Jobs > {image Job Id}: Get details of a batch image job.",
|
|
"api_call": "GET /imageJobs/{imageJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"imageJobId": "[REQUIRED] string: (Required) Image job id."
|
|
},
|
|
"functionality": "Get details of a batch image job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - image Jobs > {image Job Id}: Cancel a batch image job.",
|
|
"api_call": "POST /imageJobs/{imageJobId}/actions/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"imageJobId": "[REQUIRED] string: (Required) Image job id."
|
|
},
|
|
"functionality": "Cancel a batch image job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - image Jobs: Create a batch image analysis job",
|
|
"api_call": "POST /imageJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a batch image analysis job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - model Deployments > {model Id}: Get details of a model deployment",
|
|
"api_call": "GET /modelDeployments/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: Compartment id.",
|
|
"modelId": "[REQUIRED] string: (Required) Model id."
|
|
},
|
|
"functionality": "Get details of a model deployment such as life cycle state and life cycle details.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - model Deployments > {model Id}: Delete a model deployment",
|
|
"api_call": "DELETE /modelDeployments/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: Compartment id.",
|
|
"modelId": "[REQUIRED] string: (Required) Model id."
|
|
},
|
|
"functionality": "Delete a model deployment with model id.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - model Deployments: Create a model deployment",
|
|
"api_call": "POST /modelDeployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a model deployment with model id and model type.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id} > actions: Moves a model into a different compartment",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Moves a model from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id} > actions: Get Model metadata",
|
|
"api_call": "GET /models/{modelId}/actions/getMetadata",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Gets metadata(compartmentId) of a model by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id}: Get model",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Gets a model by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id}: Update metadata about the model",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Updates model metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id}: Delete a model",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Deletes a model by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models: Gets a list of all models in a compartment",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
|
|
},
|
|
"functionality": "Returns a list of models in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models: Creates a new model",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Get project",
|
|
"api_call": "GET /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Gets a project by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Update metadata about the project",
|
|
"api_call": "PUT /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Updates project metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Delete a project",
|
|
"api_call": "DELETE /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Deletes a project by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Moves a project into a different compartment",
|
|
"api_call": "POST /projects/{projectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Moves a project from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects: Gets a list of all projects in a compartment",
|
|
"api_call": "GET /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
|
|
},
|
|
"functionality": "Returns a list of projects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects: Creates a new project",
|
|
"api_call": "POST /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new project.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Get work request status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Cancel the work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancel work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests > {workRequestId} > logs: Get work request logs.",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Get the logs of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests > {workRequestId} > errors: Get work request errors.",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"workRequestId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Get the errors of a work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests > {workRequestId}: Get Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - workRequests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > stop: Stop an integration instance that was previously in an ACTIVE state",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/stop",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Stop an integration instance that was previously in an ACTIVE state\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > start: Start an integration instance that was previously in an INACTIVE state",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/start",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Start an integration instance that was previously in an INACTIVE state\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > changeNetworkEndpoint: Change an Integration instance network endpoint.",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/changeNetworkEndpoint",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Change an Integration instance network endpoint. The operation is long-running\nand creates a new WorkRequest.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId} > actions > changeCompartment: Change the compartment for an integration instance",
|
|
"api_call": "POST /integrationInstances/{integrationInstanceId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Change the compartment for an integration instance\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId}: Delete a provisioned Integration Instance",
|
|
"api_call": "DELETE /integrationInstances/{integrationInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Deletes an Integration Instance resource by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId}: Get Integration Instance",
|
|
"api_call": "GET /integrationInstances/{integrationInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets a IntegrationInstance by identifier",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances > {integrationInstanceId}: Update the Integration Instance identified by the id",
|
|
"api_call": "PUT /integrationInstances/{integrationInstanceId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"integrationInstanceId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the Integration Instance.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances: Gets a list of all Integration Instances in a compartment",
|
|
"api_call": "GET /integrationInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order\nfor TIMECREATED is descending. Default order for DISPLAYNAME is\nascending. If no value is specified TIMECREATED is default.\n"
|
|
},
|
|
"functionality": "Returns a list of Integration Instances.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Oracle Integration API - integrationInstances: Creates a new Integration Instance",
|
|
"api_call": "POST /integrationInstances",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated before\nthen due to conflicting operations. For example, if a resource has been\ndeleted and purged from the system, then a retry of the original creation\nrequest might be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new Integration Instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > actions: Moves a resource into a different compartment.",
|
|
"api_call": "POST /queues/{queueId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Moves a queue from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > actions: Deletes all messages present in the queue at the time of invocation.",
|
|
"api_call": "POST /queues/{queueId}/actions/purge",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Deletes all messages present in the queue at the time of invocation. Only one concurrent purge operation is supported for any given queue.\nHowever multiple concurrent purge operations are supported for different queues.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > actions: Deletes multiple messages from the queue.",
|
|
"api_call": "POST /20210201/queues/{queueId}/messages/actions/deleteMessages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Deletes multiple messages from the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > actions: Updates multiple messages in the queue.",
|
|
"api_call": "POST /20210201/queues/{queueId}/messages/actions/updateMessages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Updates multiple messages in the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > {message Receipt}: Deletes a message from the queue.",
|
|
"api_call": "DELETE /20210201/queues/{queueId}/messages/{messageReceipt}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier.",
|
|
"messageReceipt": "[REQUIRED] string: (Required) The receipt of the message retrieved from a GetMessages call."
|
|
},
|
|
"functionality": "Deletes the message represented by the receipt from the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages > {message Receipt}: Updates the visibility of a message to extend (or reduce) it.",
|
|
"api_call": "PUT /20210201/queues/{queueId}/messages/{messageReceipt}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier.",
|
|
"messageReceipt": "[REQUIRED] string: (Required) The receipt of the message retrieved from a GetMessages call."
|
|
},
|
|
"functionality": "Updates the visibility of the message represented by the receipt.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages: Consumes message from the queue.",
|
|
"api_call": "GET /20210201/queues/{queueId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Consumes messages from the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id} > messages: Puts messages in the queue.",
|
|
"api_call": "POST /20210201/queues/{queueId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Puts messages into the queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Delete a provisioned Queue",
|
|
"api_call": "DELETE /queues/{queueId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Deletes a queue resource by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Get Queue",
|
|
"api_call": "GET /queues/{queueId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Gets a queue by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Update the Queue identified by the id",
|
|
"api_call": "PUT /queues/{queueId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Updates the specified queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues > {queue Id}: Gets the statistics for the queue and its dead letter queue.",
|
|
"api_call": "GET /20210201/queues/{queueId}/stats",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"queueId": "[REQUIRED] string: (Required) The unique queue identifier."
|
|
},
|
|
"functionality": "Gets the statistics for the queue and its dead letter queue.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues: Gets a list of all Queues in a compartment",
|
|
"api_call": "GET /queues",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Returns a list of queues.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - queues: Creates a new Queue",
|
|
"api_call": "POST /queues",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"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.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new queue.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests > {work Request Id}: GET Work Request Status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Queue API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"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.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources.",
|
|
"limit": "integer: 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](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine)."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Gets the properties of the specified configuration source provider.",
|
|
"api_call": "GET /configurationSourceProviders/{configurationSourceProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Gets the properties of the specified configuration source provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Updates the properties of the specified configuration source provider.",
|
|
"api_call": "PUT /configurationSourceProviders/{configurationSourceProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Updates the properties of the specified configuration source provider.\nFor more information, see\n[To edit a configuration source provider](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingconfigurationsourceproviders.htm#EditConfigurationSourceProvider).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Deletes the specified configuration source provider.",
|
|
"api_call": "DELETE /configurationSourceProviders/{configurationSourceProviderId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Deletes the specified configuration source provider.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers > {configuration Source Provider Id}: Moves a ConfigurationSourceProvider into a different compartment. When provided, If-Match is checked against ETag values of the ConfigurationSourceProvider.",
|
|
"api_call": "POST /configurationSourceProviders/{configurationSourceProviderId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"configurationSourceProviderId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the configuration source provider.\n"
|
|
},
|
|
"functionality": "Moves a configuration source provider into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers: Lists configuration source providers.",
|
|
"api_call": "GET /configurationSourceProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"configurationSourceProviderId": "string: A filter to return only configuration source providers that match the provided [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list a resource by name.\nRequires `sortBy` set to `DISPLAYNAME`.\nAlternatively, when you know the resource OCID, use the related Get operation.\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"configSourceProviderType": "string: A filter to return only configuration source providers of the specified type (GitHub or GitLab).\n"
|
|
},
|
|
"functionality": "Lists configuration source providers according to the specified filter.\n- For `compartmentId`, lists all configuration source providers in the matching compartment.\n- For `configurationSourceProviderId`, lists the matching configuration source provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - configuration Source Providers: Creates a configuration source provider in the specified compartment.",
|
|
"api_call": "POST /configurationSourceProviders",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a configuration source provider in the specified compartment.\nFor more information, see\n[To create a configuration source provider](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingconfigurationsourceproviders.htm#CreateConfigurationSourceProvider).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id} > logs: Gets log entries for a job",
|
|
"api_call": "GET /jobs/{jobId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job.",
|
|
"type": "string: A filter that returns only logs of a specified type.\n",
|
|
"levelGreaterThanOrEqualTo": "string: A filter that returns only log entries that match a given severity level or greater.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"timestampGreaterThanOrEqualTo": "number: Time stamp specifying the lower time limit for which logs are returned in a query.\nFormat is defined by RFC3339.\nExample: `2020-01-01T12:00:00.000Z`\n",
|
|
"timestampLessThanOrEqualTo": "number: Time stamp specifying the upper time limit for which logs are returned in a query.\nFormat is defined by RFC3339.\nExample: `2020-02-01T12:00:00.000Z`\n"
|
|
},
|
|
"functionality": "Returns console log entries for the specified job in JSON format.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id} > logs: Gets the raw logs for a job.",
|
|
"api_call": "GET /jobs/{jobId}/logs/content",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns a raw log file for the specified job. The raw log file contains console log entries in text format. The maximum number of entries in a file is 100,000.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Get details of a specific job.",
|
|
"api_call": "GET /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the specified job along with the job details.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Update a Job.",
|
|
"api_call": "PUT /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Updates the specified job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Cancel a Job",
|
|
"api_call": "DELETE /jobs/{jobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"isForced": "boolean: Indicates whether a forced cancellation is requested for the job while it was running.\nA forced cancellation can result in an incorrect state file.\nFor example, the state file might not reflect the exact state of the provisioned resources.\n",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Indicates the intention to cancel the specified job.\nCancellation of the job is not immediate, and may be delayed,\nor may not happen at all.\nYou can optionally choose forced cancellation by setting `isForced` to true.\nA forced cancellation can result in an incorrect state file.\nFor example, the state file might not reflect the exact state of the provisioned resources.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Gets job detailed log content.",
|
|
"api_call": "GET /jobs/{jobId}/detailedLogContent",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the Terraform detailed log content for the specified job in plain text. [Learn about Terraform detailed log.](https://www.terraform.io/docs/internals/debugging.html)\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Get zipped Terraform configuration used for a specific job.",
|
|
"api_call": "GET /jobs/{jobId}/tfConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the Terraform configuration file for the specified job in .zip format.\nReturns an error if no zip file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs > {job Id}: Get Terraform state output from a specified job.",
|
|
"api_call": "GET /jobs/{jobId}/tfState",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"jobId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the job."
|
|
},
|
|
"functionality": "Returns the Terraform state for the specified job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs: List all jobs related to a stack or compartment. By default, the list is ordered by time created.\nYou can alter the ordering by using `SortByQueryParam` and `SortOrderQueryParam`.\n",
|
|
"api_call": "GET /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"stackId": "string: The stack [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) on which to filter.\n",
|
|
"id": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) on which to query for jobs.\n",
|
|
"lifecycleState": "string: A filter that returns all resources that match the specified lifecycle state.\nThe state value is case-insensitive.\n\nAllowable values:\n- ACCEPTED\n- IN_PROGRESS\n- FAILED\n- SUCCEEDED\n- CANCELING\n- CANCELED\n",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list a resource by name.\nRequires `sortBy` set to `DISPLAYNAME`.\nAlternatively, when you know the resource OCID, use the related Get operation.\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "integer: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Returns a list of jobs in a stack or compartment, ordered by time created.\n\n- To list all jobs in a stack, provide the stack [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n- To list all jobs in a compartment, provide the compartment [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n- To return a specific job, provide the job [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - jobs: Create a Job.",
|
|
"api_call": "POST /jobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a job.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id} > actions: Moves a Stack and it's associated Jobs into a different compartment. When provided, If-Match is checked against ETag values of the Stack.",
|
|
"api_call": "POST /stacks/{stackId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Moves a Stack and it's associated Jobs into a different compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id} > actions: Checks drift status for the specified stack.\n",
|
|
"api_call": "POST /stacks/{stackId}/actions/detectDrift",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Checks drift status for the specified stack.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id} > actions: Lists drift status details for each resource defined in the specified stack.",
|
|
"api_call": "POST /stacks/{stackId}/actions/listResourceDriftDetails",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"workRequestId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request.",
|
|
"resourceDriftStatus": "string: A filter that returns only resources that match the given drift status. The value is case-insensitive.\nAllowable values -\n - NOT_CHECKED\n - MODIFIED\n - IN_SYNC\n - DELETED\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Lists drift status details for each resource defined in the specified stack.\nThe drift status details for a given resource indicate differences, if any, between the actual state\nand the expected (defined) state for that resource.\nThe drift status details correspond to the specified work request (`workRequestId`).\nIf no work request is specified, then the drift status details correspond to the latest completed work request for the stack.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Gets a stack by ID.",
|
|
"api_call": "GET /stacks/{stackId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Gets a stack using the stack ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Updates the specified stack object.",
|
|
"api_call": "PUT /stacks/{stackId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Updates the specified stack object.\nUse `UpdateStack` when you update your Terraform configuration\nand want your changes to be reflected in the execution plan.\nFor more information, see\n[To update a stack](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingstacksandjobs.htm#UpdateStack) and\n[To edit a stack](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingstacksandjobs.htm#EditStack).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Deletes a stack",
|
|
"api_call": "DELETE /stacks/{stackId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Deletes the specified stack object.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Gets the stack's zipped Terraform configuration",
|
|
"api_call": "GET /stacks/{stackId}/tfConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Returns the Terraform configuration file in .zip format for the specified stack.\nReturns an error if no zip file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks > {stack Id}: Get Terraform state of the specified stack.",
|
|
"api_call": "GET /stacks/{stackId}/tfState",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"stackId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the stack."
|
|
},
|
|
"functionality": "Returns the Terraform state for the specified stack.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks: Returns a stack or list of stacks.",
|
|
"api_call": "GET /stacks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Returns a list of stacks.\n- If called using the compartment ID, returns all stacks in the specified compartment.\n- If called using the stack ID, returns the specified stack.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - stacks: Creates a Stack.",
|
|
"api_call": "POST /stacks",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a stack in the specified compartment.\nYou can create a stack from a Terraform configuration.\nThe Terraform configuration can be directly uploaded or referenced from a source code control system.\nYou can also create a stack from an existing compartment.\nYou can also upload the Terraform configuration from an Object Storage bucket.\nFor more information, see\n[To create a stack](https://docs.oracle.com/iaas/Content/ResourceManager/Tasks/managingstacksandjobs.htm#createstack-all).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Gets the specified template.",
|
|
"api_call": "GET /templates/{templateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Gets the specified template.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Updates the specified template.",
|
|
"api_call": "PUT /templates/{templateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Updates the specified template.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Deletes the specified template.",
|
|
"api_call": "DELETE /templates/{templateId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Deletes the specified template.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Moves a template into a different compartment. When provided, If-Match is checked against ETag values of the Template.",
|
|
"api_call": "POST /templates/{templateId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the `PUT` or `DELETE` call for a resource, set the `if-match`\nparameter to the value of the etag from a previous `GET` or `POST` response for that resource. The resource\nwill be updated or deleted only if the etag you provide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Moves a template into a different compartment within the same tenancy.\nFor information about moving resources between compartments, see\n[Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Gets the template's logo file",
|
|
"api_call": "GET /templates/{templateId}/logo",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Returns the Terraform logo file in .logo format for the specified template.\nReturns an error if no logo file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates > {template Id}: Gets the template's zipped Terraform configuration",
|
|
"api_call": "GET /templates/{templateId}/tfConfig",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"templateId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template."
|
|
},
|
|
"functionality": "Returns the Terraform configuration file in .zip format for the specified template.\nReturns an error if no zip file is found.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates: Lists templates according to the specified filter.",
|
|
"api_call": "GET /templates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"templateCategoryId": "string: Unique identifier of the template category.\nPossible values are `0` (Quick Starts), `1` (Service), `2` (Architecture), and `3` (Private).\n",
|
|
"templateId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the template.",
|
|
"displayName": "string: A filter to return only resources that match the given display name exactly.\nUse this filter to list a resource by name.\nRequires `sortBy` set to `DISPLAYNAME`.\nAlternatively, when you know the resource OCID, use the related Get operation.\n",
|
|
"sortBy": "string: The field to use when sorting returned resources.\nBy default, `TIMECREATED` is ordered descending.\nBy default, `DISPLAYNAME` is ordered ascending. Note that you can sort only on one field.\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists templates according to the specified filter.\nThe attributes `compartmentId` and `templateCategoryId` are required unless `templateId` is specified.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - templates: Creates a private template in the specified compartment.",
|
|
"api_call": "POST /templates",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of retrying the same action. Retry tokens expire after\n24 hours, but can be invalidated before then due to conflicting operations. For example,\nif a resource has been deleted and purged from the system, then a retry of the original\ncreation request may be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Creates a private template in the specified compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests > {work Request Id}: Get Work Request",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Return the given work request.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"sortOrder": "string: The sort order to use when sorting returned resources. Ascending (`ASC`) or descending (`DESC`).\n",
|
|
"workRequestId": "[REQUIRED] string: (Required) The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the work request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - work Requests: Lists work requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n",
|
|
"resourceId": "string: The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the resource.",
|
|
"limit": "integer: The number of items returned in a paginated `List` call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the preceding `List` call.\nFor information about pagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).\n"
|
|
},
|
|
"functionality": "Lists the work requests in a given compartment or for a given resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - General: Lists supported Resource Discovery services.",
|
|
"api_call": "GET /resourceDiscoveryServices",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n"
|
|
},
|
|
"functionality": "Returns a list of supported services for Resource Discovery. For reference on service names, see the [Terraform provider documentation](https://www.terraform.io/docs/providers/oci/guides/resource_discovery.html#services).\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - General: Lists template categories.",
|
|
"api_call": "GET /templateCategories",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header"
|
|
},
|
|
"functionality": "Lists template categories.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Resource Manager API - General: Lists supported Terraform versions.",
|
|
"api_call": "GET /terraformVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: A filter to return only resources that exist in the compartment, identified by [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).\n"
|
|
},
|
|
"functionality": "Returns a list of supported Terraform versions for use with stacks.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Gets a connectharness",
|
|
"api_call": "GET /connectharnesses/{connectHarnessId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Gets detailed information about a connect harness.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Updates a connect harness.",
|
|
"api_call": "PUT /connectharnesses/{connectHarnessId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Updates the tags applied to the connect harness.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Deletes a connect harness.",
|
|
"api_call": "DELETE /connectharnesses/{connectHarnessId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Deletes a connect harness and its content. Connect harness contents are deleted immediately. The service retains records of the connect harness itself for 90 days after deletion.\nThe `lifecycleState` parameter of the `ConnectHarness` object changes to `DELETING` and the connect harness becomes inaccessible for read or write operations.\nTo verify that a connect harness has been deleted, make a [GetConnectHarness](https://docs.oracle.com/iaas/api/#/en/streaming/20180418/ConnectHarness/GetConnectHarness) request. If the call returns the connect harness's\nlifecycle state as `DELETED`, then the connect harness has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the\nconnect harness have been deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses > {connect Harness Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /connectharnesses/{connectHarnessId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: 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.",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"connectHarnessId": "[REQUIRED] string: (Required) The OCID of the connect harness.\n"
|
|
},
|
|
"functionality": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses: Lists the connectharnesses.",
|
|
"api_call": "GET /connectharnesses",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"limit": "integer: The maximum number of items to return. The value must be between 1 and 50. The default is 10.",
|
|
"sortBy": "string: The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.\n"
|
|
},
|
|
"functionality": "Lists the connectharness.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - connectharnesses: Create a connect harness",
|
|
"api_call": "POST /connectharnesses",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: 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 may be rejected).",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Starts the provisioning of a new connect harness.\nTo track the progress of the provisioning, you can periodically call [GetConnectHarness].\nIn the response, the `lifecycleState` parameter of the [ConnectHarness](https://docs.oracle.com/iaas/api/#/en/streaming/20180418/ConnectHarness/) object tells you its current state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Gets the stream pool",
|
|
"api_call": "GET /streampools/{streamPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Gets detailed information about the stream pool, such as Kafka settings.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Updates the stream pool.",
|
|
"api_call": "PUT /streampools/{streamPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Updates the specified stream pool.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Deletes a stream pool.",
|
|
"api_call": "DELETE /streampools/{streamPoolId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Deletes a stream pool. All containing streams will also be deleted.\nThe default stream pool of a compartment cannot be deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools > {stream Pool Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /streampools/{streamPoolId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: 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.",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamPoolId": "[REQUIRED] string: (Required) The OCID of the stream pool.\n"
|
|
},
|
|
"functionality": "Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools: List the stream pools for a given compartment ID.",
|
|
"api_call": "GET /streampools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"limit": "integer: The maximum number of items to return. The value must be between 1 and 50. The default is 10.",
|
|
"sortBy": "string: The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.\n"
|
|
},
|
|
"functionality": "List the stream pools for a given compartment ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streampools: Creates a stream pool.",
|
|
"api_call": "POST /streampools",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: 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 may be rejected).",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Starts the provisioning of a new stream pool.\nTo track the progress of the provisioning, you can periodically call GetStreamPool.\nIn the response, the `lifecycleState` parameter of the object tells you its current state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > groups/{group Name}: Returns the current state of a consumer group.",
|
|
"api_call": "GET /streams/{streamId}/groups/{groupName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n",
|
|
"groupName": "[REQUIRED] string: (Required) The name of the consumer group."
|
|
},
|
|
"functionality": "Returns the current state of a consumer group.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > groups/{group Name}: Forcefully changes the committed location of a group on a stream.",
|
|
"api_call": "PUT /streams/{streamId}/groups/{groupName}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n",
|
|
"groupName": "[REQUIRED] string: (Required) The name of the consumer group."
|
|
},
|
|
"functionality": "Forcefully changes the current location of a group as a whole; reseting processing location of all consumers to a particular location in the stream.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > messages: Gets messages from a stream.",
|
|
"api_call": "GET /streams/{streamId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"cursor": "string: (Required) The cursor used to consume the stream.\n",
|
|
"limit": "integer: The maximum number of messages to return. You can specify any value up to 10000. By default, the service returns as many messages as possible.\nConsider your average message size to help avoid exceeding throughput on the stream.\n",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Returns messages from the specified stream using the specified cursor as the starting point for consumption. By default, the number of messages returned is undefined, but the service returns as many as possible.\nTo get messages, you must first obtain a cursor using the [CreateCursor](https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/Cursor/CreateCursor) operation.\nIn the response, retrieve the value of the 'opc-next-cursor' header to pass as a parameter to get the next batch of messages in the stream.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id} > messages: Puts messages in a stream.",
|
|
"api_call": "POST /streams/{streamId}/messages",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Emits messages to a stream. There's no limit to the number of messages in a request, but the total size of a message or request must be 1 MiB or less.\nThe service calculates the partition ID from the message key and stores messages that share a key on the same partition.\nIf a message does not contain a key or if the key is null, the service generates a message key for you.\nThe partition ID cannot be passed as a parameter.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Gets a stream",
|
|
"api_call": "GET /streams/{streamId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Gets detailed information about a stream, including the number of partitions.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Updates a stream.",
|
|
"api_call": "PUT /streams/{streamId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Updates the stream. Only specified values will be updated.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Deletes a stream.",
|
|
"api_call": "DELETE /streams/{streamId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: 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.",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Deletes a stream and its content. Stream contents are deleted immediately. The service retains records of the stream itself for 90 days after deletion.\nThe `lifecycleState` parameter of the `Stream` object changes to `DELETING` and the stream becomes inaccessible for read or write operations.\nTo verify that a stream has been deleted, make a [GetStream](https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/Stream/GetStream) request. If the call returns the stream's\nlifecycle state as `DELETED`, then the stream has been deleted. If the call returns a \"404 Not Found\" error, that means all records of the\nstream have been deleted.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Moves a resource into a different compartment.",
|
|
"api_call": "POST /streams/{streamId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: 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.",
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Moves a resource into a different compartment.\nWhen provided, If-Match is checked against ETag values of the resource.\nThe stream will also be moved into the default stream pool in the destination compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Commits processed offsets to consumer group state.",
|
|
"api_call": "POST /streams/{streamId}/commit",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cursor": "string: (Required) The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.\n",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Provides a mechanism to manually commit offsets, if not using commit-on-get consumer semantics.\nThis commits offsets assicated with the provided cursor, extends the timeout on each of the affected partitions, and returns an updated cursor.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Creates a cursor for the specified stream. A cursor is used to consume a stream.",
|
|
"api_call": "POST /streams/{streamId}/cursors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Creates a cursor. Cursors are used to consume a stream, starting from a specific point in the partition and going forward from there.\nYou can create a cursor based on an offset, a time, the trim horizon, or the most recent message in the stream. As the oldest message\ninside the retention period boundary, using the trim horizon effectively lets you consume all messages in the stream. A cursor based\non the most recent message allows consumption of only messages that are added to the stream after you create the cursor. Cursors expire\nfive minutes after you receive them from the service.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Creates a group-cursor for the specified stream. A cursor is used to consume a stream.",
|
|
"api_call": "POST /streams/{streamId}/groupCursors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Creates a group-cursor.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams > {stream Id}: Extends the reservation timeout on partitions reserved by the provided cursor.",
|
|
"api_call": "POST /streams/{streamId}/heartbeat",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations",
|
|
"cursor": "string: (Required) The group-cursor representing the offsets of the group. This cursor is retrieved from the CreateGroupCursor API call.\n",
|
|
"streamId": "[REQUIRED] string: (Required) The OCID of the stream.\n"
|
|
},
|
|
"functionality": "Allows long-running processes to extend the timeout on partitions reserved by a consumer instance.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams: Lists the streams in the given compartment id.",
|
|
"api_call": "GET /streams",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"compartmentId": "string: The OCID of the compartment. Is exclusive with the `streamPoolId` parameter. One of them is required.",
|
|
"limit": "integer: The maximum number of items to return. The value must be between 1 and 50. The default is 10.",
|
|
"sortBy": "string: The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.\n",
|
|
"sortOrder": "string: The sort order to use, either 'asc' or 'desc'.\n"
|
|
},
|
|
"functionality": "Lists the streams in the given compartment id.\nIf the compartment id is specified, it will list streams in the compartment, regardless of their stream pool.\nIf the stream pool id is specified, the action will be scoped to that stream pool.\nThe compartment id and stream pool id cannot be specified at the same time.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Streaming API - streams: Creates a stream.",
|
|
"api_call": "POST /streams",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Date": "string: (Required) Current Date",
|
|
"Authorization": "string: (Required) Signature Authentication on Authorization header",
|
|
"x-content-sha256": "string: (Required) Content sha256 for POST, PUT and PATCH operations"
|
|
},
|
|
"functionality": "Starts the provisioning of a new stream.\nThe stream will be created in the given compartment id or stream pool id, depending on which parameter is specified.\nCompartment id and stream pool id cannot be specified at the same time.\nTo track the progress of the provisioning, you can periodically call [GetStream](https://docs.oracle.com/iaas/api/#/en/streaming/20180418/Stream/GetStream).\nIn the response, the `lifecycleState` parameter of the [Stream](https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/Stream/) object tells you its current state.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables > {custom Table Id}: Returns saved custom table.",
|
|
"api_call": "GET /customTables/{customTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"customTableId": "[REQUIRED] string: (Required) The custom table unique OCID."
|
|
},
|
|
"functionality": "Returns the saved custom table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables > {custom Table Id}: Update a custom table.",
|
|
"api_call": "PUT /customTables/{customTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"customTableId": "[REQUIRED] string: (Required) The custom table unique OCID."
|
|
},
|
|
"functionality": "Update a saved custom table by table ID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables > {custom Table Id}: Delete a custom table.",
|
|
"api_call": "DELETE /customTables/{customTableId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"customTableId": "[REQUIRED] string: (Required) The custom table unique OCID."
|
|
},
|
|
"functionality": "Delete a saved custom table by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables: Returns saved custom tables.",
|
|
"api_call": "GET /customTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"compartmentId": "string: (Required) The compartment ID in which to list resources.",
|
|
"savedReportId": "string: (Required) The saved report ID in which to list resources.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is displayName.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the saved custom table list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - custom Tables: Create a custom table.",
|
|
"api_call": "POST /customTables",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error, without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Returns the created custom table.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries > {query Id}: Returns saved query.",
|
|
"api_call": "GET /queries/{queryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"queryId": "[REQUIRED] string: (Required) The query unique OCID."
|
|
},
|
|
"functionality": "Returns the saved query.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries > {query Id}: Update a query.",
|
|
"api_call": "PUT /queries/{queryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"queryId": "[REQUIRED] string: (Required) The query unique OCID."
|
|
},
|
|
"functionality": "Update a saved query by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries > {query Id}: Delete a query.",
|
|
"api_call": "DELETE /queries/{queryId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"queryId": "[REQUIRED] string: (Required) The query unique OCID."
|
|
},
|
|
"functionality": "Delete a saved query by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries: Returns saved queries and UI properties.",
|
|
"api_call": "GET /queries",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"compartmentId": "string: (Required) The compartment ID in which to list resources.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is displayName.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the saved query list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - queries: Create a query.",
|
|
"api_call": "POST /queries",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error, without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Returns the created query.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - scheduled Runs: Returns schedule history list.",
|
|
"api_call": "GET /scheduledRuns",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"scheduleId": "string: (Required) The schedule unique ID.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is timeCreated.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the schedule history list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - scheduled Runs: Returns saved schedule run.",
|
|
"api_call": "GET /scheduledRuns/{scheduledRunId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"scheduledRunId": "[REQUIRED] string: (Required) The scheduled run unique OCID."
|
|
},
|
|
"functionality": "Returns the saved schedule run.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules > {schedule Id}: Returns saved schedule.",
|
|
"api_call": "GET /schedules/{scheduleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"scheduleId": "[REQUIRED] string: (Required) The schedule unique OCID."
|
|
},
|
|
"functionality": "Returns the saved schedule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules > {schedule Id}: Update schedule.",
|
|
"api_call": "PUT /schedules/{scheduleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"scheduleId": "[REQUIRED] string: (Required) The schedule unique OCID."
|
|
},
|
|
"functionality": "Update a saved schedule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules > {schedule Id}: Delete a schedule.",
|
|
"api_call": "DELETE /schedules/{scheduleId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted, only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"Accept": "string",
|
|
"scheduleId": "[REQUIRED] string: (Required) The schedule unique OCID."
|
|
},
|
|
"functionality": "Delete a saved scheduled report by the OCID.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules: Returns the saved schedule list.",
|
|
"api_call": "GET /schedules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The compartment ID in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortBy": "string: The field to sort by. If not specified, the default is timeCreated.\n",
|
|
"sortOrder": "string: The sort order to use, whether 'asc' or 'desc'."
|
|
},
|
|
"functionality": "Returns the saved schedule list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - schedules: Create a schedule.",
|
|
"api_call": "POST /schedules",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error, without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Returns the created schedule.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - General: Returns configurations.",
|
|
"api_call": "GET /configuration",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Accept": "string",
|
|
"tenantId": "string: (Required) tenant id"
|
|
},
|
|
"functionality": "Returns the configurations list for the UI drop-down list.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Usage API - General: Returns usage for the given account.",
|
|
"api_call": "POST /usage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a\nparticular request, please provide the request ID.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return."
|
|
},
|
|
"functionality": "Returns usage for the given account.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > verify: Verifies signed data by using the given VerifyDataDetails resource.",
|
|
"api_call": "POST /20180608/verify",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Verifies a digital signature that was generated by the [Sign](https://docs.oracle.com/iaas/api/#/en/key/latest/SignedData/Sign) operation\nby using the public key of the same asymmetric key that was used to sign the data. If you want to validate the\ndigital signature outside of the service, you can do so by using the public key of the asymmetric key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > usage: Gets the specified vault's usage against service limits.",
|
|
"api_call": "GET /20180608/vaults/{vaultId}/usage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets the count of keys and key versions in the specified vault to calculate usage against service limits.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > scheduleDeletion: Schedules the deletion of a vault.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it\nthat are not already scheduled for deletion to `PENDING_DELETION` and then deletes them after the\nretention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won't\nchange. If any keys in the vault are scheduled to be deleted after the specified time of\ndeletion for the vault, the call is rejected with the error code 409.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > listReplicas: Lists the replicas for a vault",
|
|
"api_call": "GET /20180608/vaults/{vaultId}/actions/listReplicas",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists the replicas for a vault\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > deleteReplica: Deletes a vault replica",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/deleteReplica",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Deletes a vault replica\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > createReplica: Creates a replica for the vault in another region in the same realm",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/createReplica",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Creates a replica for the vault in another region in the same realm\n\nThe API is a no-op if called for same region that a vault is already replicated to.\n409 if called on a vault that is already replicated to a different region. Users need to delete\nexisting replica first before calling it with a different region.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > changeCompartment: Moves a vault into a different compartment.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Moves a vault into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the resource.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > cancelDeletion: Cancels the scheduled deletion of a vault.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion\nrestores the vault and all keys in it to their respective states from before their\nscheduled deletion. All keys that were scheduled for deletion prior to vault\ndeletion retain their lifecycle state and time of deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId} > actions > backup: Backs up a vault.",
|
|
"api_call": "POST /20180608/vaults/{vaultId}/actions/backup",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later.\nYou can backup a vault whether or not it contains keys. This operation only backs up the\nmetadata of the vault, and does not include key metadata.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId}: Gets details about a vault.",
|
|
"api_call": "GET /20180608/vaults/{vaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets the specified vault's configuration information.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > {vaultId}: Updates the properties of a vault.",
|
|
"api_call": "PUT /20180608/vaults/{vaultId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"vaultId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the properties of a vault. Specifically, you can update the\n`displayName`, `freeformTags`, and `definedTags` properties. Furthermore,\nthe vault must be in an ACTIVE or CREATING state to be updated.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > actions > restoreFromObjectStore: Restores a vault from an object storage location.",
|
|
"api_call": "POST /20180608/vaults/actions/restoreFromObjectStore",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Restores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object\nStorage. If a vault with the same OCID already exists, this operation returns\na response with a 409 HTTP status error code.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults > actions > restoreFromFile: Restores a vault from an encrypted backup file.",
|
|
"api_call": "POST /20180608/vaults/actions/restoreFromFile",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"content-md5": "string: The base64-encoded MD5 hash value of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15.\nIf the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5\nhash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and\na response with 400 Unmatched Content MD5 error is returned, along with the message: \"The computed MD5 of the request body (ACTUAL_MD5)\ndoes not match the Content-MD5 header (HEADER_MD5).\"\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment."
|
|
},
|
|
"functionality": "Restores a vault from an encrypted backup file. If a vault\nwith the same OCID already exists, this operation returns a response with a\n409 HTTP status error code.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults: Lists vaults in the compartment.",
|
|
"api_call": "GET /20180608/vaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
|
|
},
|
|
"functionality": "Lists the vaults in the specified compartment.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > vaults: Creates a new vault.",
|
|
"api_call": "POST /20180608/vaults",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new vault. The type of vault you create determines key placement, pricing, and\navailable options. Options include storage isolation, a dedicated service endpoint instead\nof a shared service endpoint for API calls, and either a dedicated hardware security module\n(HSM) or a multitenant HSM.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > sign: Signs data by using the given SignDataDetails resource.",
|
|
"api_call": "POST /20180608/sign",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a digital signature for a message or message digest by using the private key of a public-private key pair,\nalso known as an asymmetric key. To verify the generated signature, you can use the [Verify](https://docs.oracle.com/iaas/api/#/en/key/latest/VerifiedData/Verify)\noperation. Or, if you want to validate the signature outside of the service, you can do so by using the public key of the same asymmetric key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > replicaOperations > {replicationId} > status: Gets the replication status of a replica operation",
|
|
"api_call": "GET /20180608/replicaOperations/{replicationId}/status",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"replicationId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "When a vault has a replica, each operation on the vault or its resources, such as\nkeys, is replicated and has an associated replicationId. Replication status provides\ndetails about whether the operation associated with the given replicationId has been\nsuccessfully applied across replicas.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > {keyVersionId} > actions > scheduleDeletion: Schedules the deletion of a key version.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string",
|
|
"keyVersionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified key version. This sets the lifecycle state of the key version\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > {keyVersionId} > actions > cancelDeletion: Cancels the scheduled deletion of a key version.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions/{keyVersionId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string",
|
|
"keyVersionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of the specified key version. Canceling\na scheduled deletion restores the key version to its lifecycle state from\nbefore its scheduled deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > {keyVersionId}: Gets details about a key version.",
|
|
"api_call": "GET /20180608/keys/{keyId}/keyVersions/{keyVersionId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string",
|
|
"keyVersionId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified key version.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions > import: Imports the given wrapped key material and then rotate the key to begin using the new key version for the specified key.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions/import",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Imports AES key material to create a new key version and then rotate the key to begin using the new\nkey version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key\nbefore you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes.\nFurthermore, the key length must match the length of the specified key and what you specify as the length\nat the time of import. When importing an asymmetric key, only the private key must be wrapped in PKCS8 format \nwhile the corresponding public key is generated internally by KMS.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions: Lists all key versions for a key.",
|
|
"api_call": "GET /20180608/keys/{keyId}/keyVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"limit": "string: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"page": "string: The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists all [KeyVersion](https://docs.oracle.com/iaas/api/#/en/key/latest/KeyVersion/) resources for the specified\nmaster encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > keyVersions: Creates a new key version resource and rotates the key to use it for encryption.",
|
|
"api_call": "POST /20180608/keys/{keyId}/keyVersions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Generates a new [KeyVersion](https://docs.oracle.com/iaas/api/#/en/key/latest/KeyVersion/) resource that provides new cryptographic\nmaterial for a master encryption key. The key must be in an `ENABLED` state to be rotated.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > scheduleDeletion: Schedules the deletion of a key.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified key. This sets the lifecycle state of the key\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > enable: Enables a key so it can be used for cryptographic operations.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/enable",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Enables a master encryption key so it can be used for encryption, decryption, or\ngenerating new data encryption keys.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > disable: Disables a key so it cannot be used for cryptographic operations.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/disable",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Disables a master encryption key so it can no longer be used for encryption, decryption, or\ngenerating new data encryption keys.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > changeCompartment: Moves a key into a different compartment.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Moves a key into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the key.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > cancelDeletion: Cancels the scheduled deletion of a key.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of the specified key. Canceling\na scheduled deletion restores the key's lifecycle state to what\nit was before its scheduled deletion.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId} > actions > backup: Backs up the key and associated key metadata.",
|
|
"api_call": "POST /20180608/keys/{keyId}/actions/backup",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore\nthe key later. The file also contains the metadata of the vault that the key belonged to.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId}: Gets details about a key.",
|
|
"api_call": "GET /20180608/keys/{keyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified master encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second for\na given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > {keyId}: Updates a key's properties.",
|
|
"api_call": "PUT /20180608/keys/{keyId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"keyId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the properties of a master encryption key. Specifically, you can update the\n`displayName`, `freeformTags`, and `definedTags` properties. Furthermore,\nthe key must be in an `ENABLED` or `CREATING` state to be updated.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > import: Imports the given wrapped AES key.",
|
|
"api_call": "POST /20180608/keys/import",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Imports AES and RSA keys to create a new key. The key material must be base64-encoded \nand wrapped by the vault's public RSA wrapping key before you can import it. \nKey Management supports both RSA and AES keys. The AES keys are symmetric keys \nof length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). \nFurthermore, the key length must match what you specify at the time of import. When importing an asymmetric key, \nonly private key must be wrapped in PKCS8 format while the corresponding public key is generated internally by KMS.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > actions > restoreFromObjectStore: Restores a key to a vault from an object storage location.",
|
|
"api_call": "POST /20180608/keys/actions/restoreFromObjectStore",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Restores the specified key to the specified vault from an Oracle Cloud Infrastructure\nObject Storage location. If the vault doesn't exist, the operation returns a response with a\n404 HTTP status error code. You need to first restore the vault associated with the key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys > actions > restoreFromFile: Restores a key to a vault from a file.",
|
|
"api_call": "POST /20180608/keys/actions/restoreFromFile",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"content-length": "string: (Required) The content length of the body.",
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"content-md5": "string: The base64-encoded MD5 hash value of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15.\nIf the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5\nhash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don't match, the object is rejected and\na response with 400 Unmatched Content MD5 error is returned, along with the message: \"The computed MD5 of the request body (ACTUAL_MD5)\ndoes not match the Content-MD5 header (HEADER_MD5).\"\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Restores the specified key to the specified vault, based on information in the backup file provided.\nIf the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You\nneed to first restore the vault associated with the key.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys: Lists keys in the specified vault and compartment.",
|
|
"api_call": "GET /20180608/keys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
|
|
},
|
|
"functionality": "Lists the master encryption keys in the specified vault and compartment.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > keys: Creates a new key.",
|
|
"api_call": "POST /20180608/keys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new master encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total\nnumber of requests across all management write operations. Key Management might throttle this call\nto reject an otherwise valid request when the total rate of management write operations exceeds 10\nrequests per second for a given tenancy.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > generateDataEncryptionKey: GenerateDataEncryptionKey",
|
|
"api_call": "POST /20180608/generateDataEncryptionKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Generates a key that you can use to encrypt or decrypt data.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > exportKey: Exports a master encryption key.",
|
|
"api_call": "POST /20180608/exportKey",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Exports a specific version of a master encryption key according to the details of the request. For their protection,\nkeys that you create and store on a hardware security module (HSM) can never leave the HSM. You can only export keys\nstored on the server. For export, the key version is encrypted by an RSA public key that you provide.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > encrypt: Encrypt",
|
|
"api_call": "POST /20180608/encrypt",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Encrypts data using the given [EncryptDataDetails](https://docs.oracle.com/iaas/api/#/en/key/latest/datatypes/EncryptDataDetails) resource.\nPlaintext included in the example request is a base64-encoded value of a UTF-8 string.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > decrypt: Decrypt",
|
|
"api_call": "POST /20180608/decrypt",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Decrypts data using the given [DecryptDataDetails](https://docs.oracle.com/iaas/api/#/en/key/latest/datatypes/DecryptDataDetails) resource.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Key Management API - 20180608 > wrappingKeys: Gets details about the RSA wrapping key associated with the vault.",
|
|
"api_call": "GET /20180608/wrappingKeys",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and\nunwraps AES key material for import into Key Management.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > versions: Lists all secret versions for a secret.",
|
|
"api_call": "GET /secrets/{secretId}/versions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"limit": "string: The maximum number of items to return in a paginated \"List\" call.\n",
|
|
"page": "string: The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Time created is default ordered as descending. Display name is default ordered as ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists all secret versions for the specified secret.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > version > {secretVersionNumber} > actions > scheduleDeletion: Schedules a deletion of a secret version.",
|
|
"api_call": "POST /secrets/{secretId}/version/{secretVersionNumber}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string",
|
|
"secretVersionNumber": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only\ndelete a secret version if the secret version rotation state is marked as `DEPRECATED`.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > version > {secretVersionNumber} > actions > cancelDeletion: Cancels a scheduled secret version deletion.",
|
|
"api_call": "POST /secrets/{secretId}/version/{secretVersionNumber}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string",
|
|
"secretVersionNumber": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the scheduled deletion of a secret version.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > version > {secretVersionNumber}: Gets details about a secret version.",
|
|
"api_call": "GET /secrets/{secretId}/version/{secretVersionNumber}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string",
|
|
"secretVersionNumber": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified version of a secret.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > actions > scheduleDeletion: Schedules the deletion of a secret.",
|
|
"api_call": "POST /secrets/{secretId}/actions/scheduleDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Schedules the deletion of the specified secret. This sets the lifecycle state of the secret\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > actions > changeCompartment: Moves a secret into a different compartment.",
|
|
"api_call": "POST /secrets/{secretId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Moves a secret into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the secret.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId} > actions > cancelDeletion: Cancels a scheduled secret deletion.",
|
|
"api_call": "POST /secrets/{secretId}/actions/cancelDeletion",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Cancels the pending deletion of the specified secret. Canceling\na scheduled deletion restores the secret's lifecycle state to what\nit was before you scheduled the secret for deletion.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId}: Gets details about a secret.",
|
|
"api_call": "GET /secrets/{secretId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets information about the specified secret.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets > {secretId}: Updates a secret's properties.",
|
|
"api_call": "PUT /secrets/{secretId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call for a\nresource, set the `if-match` parameter to the value of the etag from a\nprevious GET or POST response for that resource. The resource will be\nupdated or deleted only if the etag you provide matches the resource's\ncurrent etag value.\n",
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Updates the properties of a secret. Specifically, you can update the version number of the secret to make\nthat version number the current version. You can also update a secret's description, its free-form or defined tags, rules\nand the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the\nsame time. Furthermore, the secret must in an `ACTIVE` lifecycle state to be updated.\n\nThis operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets: Lists all secrets.",
|
|
"api_call": "GET /secrets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"Accept": "string",
|
|
"compartmentId": "string: (Required) The OCID of the compartment.",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default order for\n`TIMECREATED` is descending. The default order for `NAME` is ascending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
|
|
},
|
|
"functionality": "Lists all secrets in the specified vault and compartment.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Management API - secrets: Creates a secret.",
|
|
"api_call": "POST /secrets",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request. If provided, the returned request ID\nwill include this value. Otherwise, a random request ID will be\ngenerated by the service.\n",
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case\nof a timeout or server error without risk of executing that same action\nagain. Retry tokens expire after 24 hours, but can be invalidated\nbefore then due to conflicting operations (e.g., if a resource has been\ndeleted and purged from the system, then a retry of the original\ncreation request may be rejected).\n",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new secret according to the details of the request.\n\nThis operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Retrieval API - secretbundles > {secretId} > versions: Lists all secret bundle versions.",
|
|
"api_call": "GET /secretbundles/{secretId}/versions",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return in a paginated \"List\" call. For information about pagination, see\n[List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#List_Pagination).\n",
|
|
"page": "string: The value of the `opc-next-page` response header from the previous \"List\" call. For information about\npagination, see [List Pagination](https://docs.oracle.com/iaas/Content/API/Concepts/usingapi.htm#List_Pagination).\n",
|
|
"sortBy": "string: The field to sort by. You can specify only one sort order. The default\norder for `VERSION_NUMBER` is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Lists all secret bundle versions for the specified secret.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Retrieval API - secretbundles > {secretId}: Gets a secret bundle.",
|
|
"api_call": "GET /secretbundles/{secretId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.",
|
|
"Accept": "string",
|
|
"versionNumber": "integer: The version number of the secret.",
|
|
"secretVersionName": "string: The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.)",
|
|
"stage": "string: The rotation state of the secret version.",
|
|
"secretId": "[REQUIRED] string"
|
|
},
|
|
"functionality": "Gets a secret bundle that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter.\nIf none of these parameters are provided, the bundle for the secret version marked as `CURRENT` will be returned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vault Secret Retrieval API - secretbundles > actions > getByName: Gets a secret bundle by secret name and vault ID.",
|
|
"api_call": "POST /secretbundles/actions/getByName",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: Unique identifier for the request.",
|
|
"Accept": "string",
|
|
"secretName": "string: (Required) A user-friendly name for the secret. Secret names are unique within a vault. Secret names are case-sensitive.",
|
|
"vaultId": "string: (Required) The OCID of the vault that contains the secret.",
|
|
"versionNumber": "integer: The version number of the secret.",
|
|
"secretVersionName": "string: The name of the secret. (This might be referred to as the name of the secret version. Names are unique across the different versions of a secret.)",
|
|
"stage": "string: The rotation state of the secret version."
|
|
},
|
|
"functionality": "Gets a secret bundle by secret name and vault ID, and secret version that matches either the specified `stage`, `secretVersionName`, or `versionNumber` parameter.\nIf none of these parameters are provided, the bundle for the secret version marked as `CURRENT` is returned.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - actions: Perform document analysis",
|
|
"api_call": "POST /actions/analyzeDocument",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Perform different types of image analysis.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - actions: Perform image analysis",
|
|
"api_call": "POST /actions/analyzeImage",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Perform different types of image analysis.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - document Jobs > {document Job Id}: Get details of a batch document job",
|
|
"api_call": "GET /documentJobs/{documentJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"documentJobId": "[REQUIRED] string: (Required) Document job id."
|
|
},
|
|
"functionality": "Get details of a batch document job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - document Jobs > {document Job Id}: Cancel a batch document job.",
|
|
"api_call": "POST /documentJobs/{documentJobId}/actions/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"documentJobId": "[REQUIRED] string: (Required) Document job id."
|
|
},
|
|
"functionality": "Cancel a batch document job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - document Jobs: Create a batch document analysis job",
|
|
"api_call": "POST /documentJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a batch document analysis job\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - image Jobs > {image Job Id}: Get details of a batch image job.",
|
|
"api_call": "GET /imageJobs/{imageJobId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"imageJobId": "[REQUIRED] string: (Required) Image job id."
|
|
},
|
|
"functionality": "Get details of a batch image job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - image Jobs > {image Job Id}: Cancel a batch image job.",
|
|
"api_call": "POST /imageJobs/{imageJobId}/actions/cancel",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"imageJobId": "[REQUIRED] string: (Required) Image job id."
|
|
},
|
|
"functionality": "Cancel a batch image job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - image Jobs: Create a batch image analysis job",
|
|
"api_call": "POST /imageJobs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a batch image analysis job.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - model Deployments > {model Id}: Get details of a model deployment",
|
|
"api_call": "GET /modelDeployments/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: Compartment id.",
|
|
"modelId": "[REQUIRED] string: (Required) Model id."
|
|
},
|
|
"functionality": "Get details of a model deployment such as life cycle state and life cycle details.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - model Deployments > {model Id}: Delete a model deployment",
|
|
"api_call": "DELETE /modelDeployments/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: Compartment id.",
|
|
"modelId": "[REQUIRED] string: (Required) Model id."
|
|
},
|
|
"functionality": "Delete a model deployment with model id.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - model Deployments: Create a model deployment",
|
|
"api_call": "POST /modelDeployments",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Create a model deployment with model id and model type.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id} > actions: Moves a model into a different compartment",
|
|
"api_call": "POST /models/{modelId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Moves a model from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id} > actions: Get Model metadata",
|
|
"api_call": "GET /models/{modelId}/actions/getMetadata",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Gets metadata(compartmentId) of a model by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id}: Get model",
|
|
"api_call": "GET /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Gets a model by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id}: Update metadata about the model",
|
|
"api_call": "PUT /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Updates model metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models > {model Id}: Delete a model",
|
|
"api_call": "DELETE /models/{modelId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"modelId": "[REQUIRED] string: (Required) unique model identifier."
|
|
},
|
|
"functionality": "Deletes a model by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models: Gets a list of all models in a compartment",
|
|
"api_call": "GET /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
|
|
},
|
|
"functionality": "Returns a list of models in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - models: Creates a new model",
|
|
"api_call": "POST /models",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new model.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Get project",
|
|
"api_call": "GET /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Gets a project by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Update metadata about the project",
|
|
"api_call": "PUT /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Updates project metadata.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Delete a project",
|
|
"api_call": "DELETE /projects/{projectId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Deletes a project by identifier.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects > {project Id}: Moves a project into a different compartment",
|
|
"api_call": "POST /projects/{projectId}/actions/changeCompartment",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string",
|
|
"projectId": "[REQUIRED] string: (Required) unique project identifier."
|
|
},
|
|
"functionality": "Moves a project from one compartment to another. When provided, If-Match is checked against ETag values of the resource.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects: Gets a list of all projects in a compartment",
|
|
"api_call": "GET /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources.",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n"
|
|
},
|
|
"functionality": "Returns a list of projects.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - projects: Creates a new project",
|
|
"api_call": "POST /projects",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-retry-token": "string: A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Content-Type": "string",
|
|
"Accept": "string"
|
|
},
|
|
"functionality": "Creates a new project.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Get work request status",
|
|
"api_call": "GET /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Gets the status of the work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Cancel the work request",
|
|
"api_call": "DELETE /workRequests/{workRequestId}",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"if-match": "string: For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n",
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Cancel work request with the given ID.",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Lists work request errors",
|
|
"api_call": "GET /workRequests/{workRequestId}/errors",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of errors for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests > {work Request Id}: Lists work request logs",
|
|
"api_call": "GET /workRequests/{workRequestId}/logs",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"limit": "integer: The maximum number of items to return.",
|
|
"sortBy": "string: The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending.\n",
|
|
"sortOrder": "string: The sort order to use, either 'ASC' or 'DESC'.",
|
|
"workRequestId": "[REQUIRED] string: (Required) The ID of the asynchronous request."
|
|
},
|
|
"functionality": "Return a (paginated) list of logs for a given work request.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
},
|
|
{
|
|
"user_name": "meenakshimittal",
|
|
"api_name": "Oracle Cloud Infrastructure: Vision API - work Requests: List Work Requests",
|
|
"api_call": "GET /workRequests",
|
|
"api_version": "1.0.0",
|
|
"api_arguments": {
|
|
"opc-request-id": "string: The client request ID for tracing.",
|
|
"Accept": "string",
|
|
"compartmentId": "string: The ID of the compartment in which to list resources."
|
|
},
|
|
"functionality": "Lists the work requests in a compartment.\n",
|
|
"metadata": {
|
|
"documentation_link": "https://docs.oracle.com/en-us/iaas/api/#/"
|
|
}
|
|
}
|
|
] |