{ "opencollection": "1.0.0", "info": { "name": "Oracle Subscription API", "version": "1.0" }, "items": [ { "info": { "name": "subscription", "type": "folder" }, "items": [ { "info": { "name": "Lists subscriptions that are consumed by the compartment. Only root compartment is allowed.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/assignedSubscriptions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "The ID of the subscription to which the tenancy is associated." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided.\n* The default order for timeCreated is descending.\n* The default order for displayName is ascending.\n* If no value is specified, timeCreated is the default.\n" }, { "name": "entityVersion", "value": "", "type": "query", "description": "The version of the subscription entity." } ] }, "docs": "Lists subscriptions that are consumed by the compartment. Only the root compartment is allowed." }, { "info": { "name": "Get assigned subscription details by assigned subscription ID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/assignedSubscriptions/:assignedSubscriptionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assignedSubscriptionId", "value": "", "type": "path", "description": "OCID of the assigned Oracle Cloud Subscription." } ] }, "docs": "Get the assigned subscription details by assigned subscription ID." }, { "info": { "name": "List line item summaries that a assigned subscription owns.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/assignedSubscriptions/:assignedSubscriptionId/assignedSubscriptionLineItems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "assignedSubscriptionId", "value": "", "type": "path", "description": "OCID of the assigned Oracle Cloud Subscription." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided.\n* The default order for timeCreated is descending.\n* The default order for displayName is ascending.\n* If no value is specified, timeCreated is the default.\n" } ] }, "docs": "List line item summaries that a assigned subscription owns." }, { "info": { "name": "List subscription mappings for all the subscriptions owned by a given compartmentId. Only root compartment is allowed.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/subscriptionMappings", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "query", "description": "OCID of the subscription." }, { "name": "subscriptionMappingId", "value": "", "type": "query", "description": "A unique ID for subscription and tenancy mapping." }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "The lifecycle state of the resource." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided.\n* The default order for timeCreated is descending.\n* The default order for displayName is ascending.\n* If no value is specified, timeCreated is the default.\n" } ] }, "docs": "Lists the subscription mappings for all the subscriptions owned by a given compartmentId. Only the root compartment is allowed." }, { "info": { "name": "Assign the tenancy record identified by the compartment ID to the given subscription ID.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/subscriptionMappings", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign the tenancy record identified by the compartment ID to the given subscription ID." }, { "info": { "name": "Get the subscription mapping details by subscription mapping ID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/subscriptionMappings/:subscriptionMappingId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriptionMappingId", "value": "", "type": "path", "description": "OCID of the subscriptionMappingId." } ] }, "docs": "Get the subscription mapping details by subscription mapping ID." }, { "info": { "name": "Delete subscription mapping details by subscription mapping ID.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220518/subscriptionMappings/:subscriptionMappingId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "subscriptionMappingId", "value": "", "type": "path", "description": "OCID of the subscription mapping ID." } ] }, "docs": "Delete the subscription mapping details by subscription mapping ID." }, { "info": { "name": "List subscriptions that a compartment owns. Only root compartment is allowed.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/subscriptions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "subscriptionId", "value": "", "type": "query", "description": "The ID of the subscription to which the tenancy is associated." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided.\n* The default order for timeCreated is descending.\n* The default order for displayName is ascending.\n* If no value is specified, timeCreated is the default.\n" }, { "name": "entityVersion", "value": "", "type": "query", "description": "The version of the subscription entity." } ] }, "docs": "List the subscriptions that a compartment owns. Only the root compartment is allowed." }, { "info": { "name": "Creates a Subscription.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/subscriptions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a Subscription.\n" }, { "info": { "name": "Get subscription details by subscriptionId. Returns either a ClassicSubscription resource or a Subscription resource.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/subscriptions/:subscriptionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "OCID of the subscription." } ] }, "docs": "Gets the subscription details by subscription ID." }, { "info": { "name": "Updates a Subscription.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220518/subscriptions/:subscriptionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The unique identifier for the subscription." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Subscription." }, { "info": { "name": "Deletes a Subscription.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220518/subscriptions/:subscriptionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The unique identifier for the subscription." } ] }, "docs": "Deletes a Subscription." }, { "info": { "name": "List available regions based on subscription ID.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/subscriptions/:subscriptionId/availableRegions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "OCID of the subscription." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." } ] }, "docs": "List the available regions based on subscription ID." }, { "info": { "name": "Lists the line items in a subscription.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/subscriptions/:subscriptionId/subscriptionLineItems", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "OCID of the subscription." }, { "name": "page", "value": "", "type": "query", "description": "The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, whether 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order can be provided.\n* The default order for timeCreated is descending.\n* The default order for displayName is ascending.\n* If no value is specified, timeCreated is the default.\n" } ] }, "docs": "Lists the line items in a subscription." }, { "info": { "name": "Cancels a Subscription.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/subscriptions/:subscriptionId/actions/cancel", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The unique identifier for the subscription." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Requests cancellation of a Subscription. The subscription transitions to PendingCancellation\nand remains active until the end of the current billing cycle, at which point it transitions\nto Canceled. The subscription must be in the Active state to be canceled.\n" }, { "info": { "name": "Moves a Subscription into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220518/subscriptions/:subscriptionId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The unique identifier for the subscription." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a Subscription into a different compartment within the same tenancy. For information about moving resources between\ncompartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n" }, { "info": { "name": "Gets a token of Subscriptions.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/subscriptions/:subscriptionId/token", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "The unique identifier for the subscription." } ] }, "docs": "Gets a token of Subscriptions.\n" }, { "info": { "name": "List work requests", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "status", "value": "", "type": "query", "description": "A filter to return only the resources that match the given lifecycle state." }, { "name": "resourceId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource affected by the work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timeAccepted` is descending.\n" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get work request status", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Gets the details of a work request." }, { "info": { "name": "Cancel work request", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220518/workRequests/:workRequestId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." } ] }, "docs": "Cancels a work request." }, { "info": { "name": "List work request errors", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the errors for a work request.\n" }, { "info": { "name": "List work request logs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220518/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the asynchronous work request." }, { "name": "page", "value": "", "type": "query", "description": "For list pagination. The value of the opc-next-page response header from the previous\n\"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "limit", "value": "", "type": "query", "description": "For list pagination. The maximum number of results per page, or items to return in a\npaginated \"List\" call. For important details about how pagination works, see\n[List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. Only one sort order may be provided. Default order for `timestamp` is descending.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." } ] }, "docs": "Lists the logs for a work request.\n" } ] } ], "bundled": true }