{ "opencollection": "1.0.0", "info": { "name": "Oracle Cloud Bridge Ocb Agent Svc API", "version": "20220509" }, "items": [ { "info": { "name": "ocbAgentSvc", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all AgentDependencies in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/agentDependencies", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "agentId", "value": "", "type": "query", "description": "A filter to return only resources that match the given Agent ID." }, { "name": "environmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the given environment ID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "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 for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of AgentDependencies such as AgentDependencyCollection.\n" }, { "info": { "name": "Creates an AgentDependency.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/agentDependencies", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an AgentDependency.\n" }, { "info": { "name": "Gets an AgentDependency.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/agentDependencies/:agentDependencyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentDependencyId", "value": "", "type": "path", "description": "A unique AgentDependency identifier." } ] }, "docs": "Gets an AgentDependency by identifier." }, { "info": { "name": "Updates the AgentDependency identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220509/agentDependencies/:agentDependencyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "agentDependencyId", "value": "", "type": "path", "description": "A unique AgentDependency identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the AgentDependency." }, { "info": { "name": "Deletes a provisioned AgentDependency.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220509/agentDependencies/:agentDependencyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentDependencyId", "value": "", "type": "path", "description": "A unique AgentDependency identifier." } ] }, "docs": "Deletes the AgentDependency resource based on an identifier." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/agentDependencies/:agentDependencyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "agentDependencyId", "value": "", "type": "path", "description": "A unique AgentDependency identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a AgentDependency resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Gets a list of all Agents in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/agents", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "environmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the given environment ID." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "agentId", "value": "", "type": "query", "description": "A filter to return only resources that match the given Agent ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "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 for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of Agents.\n" }, { "info": { "name": "Creates an Agent.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/agents", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an Agent.\n" }, { "info": { "name": "Gets an Agent.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/agents/:agentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Unique Agent identifier path parameter." } ] }, "docs": "Gets an Agent by identifier." }, { "info": { "name": "Updates the Agent identified by the ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220509/agents/:agentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Unique Agent identifier path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the Agent." }, { "info": { "name": "Deletes a provisioned Agent.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220509/agents/:agentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Unique Agent identifier path parameter." } ] }, "docs": "Deletes an Agent resource identified by an identifier." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/agents/:agentId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Unique Agent identifier path parameter." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves an Agent resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Gets a plugin by identifier.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/agents/:agentId/plugins/:pluginName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "agentId", "value": "", "type": "path", "description": "Unique Agent identifier path parameter." }, { "name": "pluginName", "value": "", "type": "path", "description": "Unique plugin identifier path parameter." } ] }, "docs": "Gets a plugin by identifier." }, { "info": { "name": "Gets a list of all Appliance Images.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/applianceImages", "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 filter to return only resources that match the entire display name given." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "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 for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of Appliance Images.\n" }, { "info": { "name": "Gets a list of all source environments in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/environments", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ID of the compartment in which to list resources." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources where their lifecycleState matches the given lifecycleState." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "environmentId", "value": "", "type": "query", "description": "A filter to return only resources that match the given environment ID." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "query", "description": "A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response." }, { "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 for timeCreated is descending. Default order for displayName is ascending.\n" } ] }, "docs": "Returns a list of source environments.\n" }, { "info": { "name": "Creates source environment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/environments", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a source environment.\n" }, { "info": { "name": "Gets a source environment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220509/environments/:environmentId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "Unique environment identifier." } ] }, "docs": "Gets a source environment by identifier." }, { "info": { "name": "Updates the source environment identified by the id ID.", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20220509/environments/:environmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "Unique environment identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the source environment." }, { "info": { "name": "Deletes a provisioned source environment.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20220509/environments/:environmentId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "Unique environment identifier." } ] }, "docs": "Deletes a the source environment resource identified by an identifier." }, { "info": { "name": "Add a dependency to the environment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/environments/:environmentId/actions/addAgentDependency", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "Unique environment identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a dependency to the environment. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Moves a resource into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/environments/:environmentId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "Unique environment identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a source environment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource." }, { "info": { "name": "Adds a dependency to the source environment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220509/environments/:environmentId/actions/removeAgentDependency", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "environmentId", "value": "", "type": "path", "description": "Unique environment identifier." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a dependency to the source environment. When provided, If-Match is checked against ETag values of the resource." } ] } ], "bundled": true }