{ "opencollection": "1.0.0", "info": { "name": "Visual Builder Vb Instance API", "version": "20210601" }, "items": [ { "info": { "name": "vbInstance", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all Vb Instances in a compartment", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20210601/vbInstances", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "displayName", "value": "", "type": "query", "description": "A user-friendly name. Does not have to be unique, and it's changeable.\n\nExample: `My new resource`\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "Life cycle state to query on." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "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": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'asc' or 'desc'." }, { "name": "sortBy", "value": "", "type": "query", "description": "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" } ] }, "docs": "Returns a list of Vb Instances.\n" }, { "info": { "name": "Creates a new Vb Instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20210601/vbInstances", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Vb Instance.\n" }, { "info": { "name": "Get Vb Instance", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20210601/vbInstances/:vbInstanceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vbInstanceId", "value": "", "type": "path", "description": "Unique Vb Instance identifier." } ] }, "docs": "Gets a VbInstance by identifier" }, { "info": { "name": "Update the Vb Instance identified by the id", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20210601/vbInstances/:vbInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vbInstanceId", "value": "", "type": "path", "description": "Unique Vb Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Vb Instance." }, { "info": { "name": "Delete a provisioned Vb Instance", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20210601/vbInstances/:vbInstanceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "vbInstanceId", "value": "", "type": "path", "description": "Unique Vb Instance identifier." } ] }, "docs": "Deletes an Vb Instance resource by identifier." }, { "info": { "name": "Summarizes the applications for a vb instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20210601/vbInstances/:vbInstanceId/actions/applications", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vbInstanceId", "value": "", "type": "path", "description": "Unique Vb Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Summarizes the applications for a vb instance." }, { "info": { "name": "Change the compartment for an vb instance", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20210601/vbInstances/:vbInstanceId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vbInstanceId", "value": "", "type": "path", "description": "Unique Vb Instance identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the compartment for an vb instance\n" }, { "info": { "name": "Start an vb instance that was previously in an INACTIVE state", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20210601/vbInstances/:vbInstanceId/actions/start", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vbInstanceId", "value": "", "type": "path", "description": "Unique Vb Instance identifier." } ] }, "docs": "Start an vb instance that was previously in an INACTIVE state. If the previous state is not\nINACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.\n" }, { "info": { "name": "Stop an vb instance that was previously in an ACTIVE state", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20210601/vbInstances/:vbInstanceId/actions/stop", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "vbInstanceId", "value": "", "type": "path", "description": "Unique Vb Instance identifier." } ] }, "docs": "Stop an vb instance that was previously in an ACTIVE state. If the previous state is not\nACTIVE, then the state of the vbInstance will not be changed and a 409 response returned.\n" }, { "info": { "name": "List Work Requests", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20210601/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "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": "vbInstanceId", "value": "", "type": "query", "description": "The Vb Instance identifier to use to filter results" } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get Work Request Status", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20210601/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Get work request errors.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20210601/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "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": "Get the errors of a work request." }, { "info": { "name": "Get work request logs.", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20210601/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "workRequestId", "value": "", "type": "path", "description": "The ID of the asynchronous request." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "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": "Get the logs of a work request." } ] } ], "bundled": true }