{ "opencollection": "1.0.0", "info": { "name": "Bastion API", "version": "20210331" }, "items": [ { "info": { "name": "bastion", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a list of all bastions in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/bastions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier (OCID) of the compartment in which to list resources." }, { "name": "bastionLifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "bastionId", "value": "", "type": "query", "description": "The unique identifier (OCID) of the bastion in which to list resources." }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire name given." }, { "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 for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Retrieves a list of BastionSummary objects in a compartment. Bastions provide secured, public access to target resources in the cloud that you cannot otherwise reach from the internet.\n" }, { "info": { "name": "Creates a new bastion.", "type": "http" }, "http": { "method": "POST", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/bastions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new bastion. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. A bastion resides in a public subnet and establishes the network infrastructure needed to connect a user to a target resource in a private subnet.\n" }, { "info": { "name": "Retrieves a bastion.", "type": "http" }, "http": { "method": "GET", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/bastions/:bastionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bastionId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the bastion." } ] }, "docs": "Retrieves a bastion identified by the bastion ID. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet." }, { "info": { "name": "Updates a bastion.", "type": "http" }, "http": { "method": "PUT", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/bastions/:bastionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bastionId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the bastion." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the bastion identified by the bastion ID. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet." }, { "info": { "name": "Deletes a bastion.", "type": "http" }, "http": { "method": "DELETE", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/bastions/:bastionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bastionId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the bastion." } ] }, "docs": "Deletes a bastion identified by the bastion ID." }, { "info": { "name": "Moves a bastion into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/bastions/:bastionId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "bastionId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the bastion." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a bastion into a different compartment." }, { "info": { "name": "Retrieves a list of all sessions in a bastion resource.", "type": "http" }, "http": { "method": "GET", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/sessions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "bastionId", "value": "", "type": "query", "description": "The unique identifier (OCID) of the bastion in which to list sessions." }, { "name": "sessionLifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "sessionId", "value": "", "type": "query", "description": "The unique identifier (OCID) of the session in which to list resources." }, { "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 for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.\n" } ] }, "docs": "Retrieves a list of SessionSummary objects for an existing bastion. Bastion sessions let authorized users connect to a target resource for a predetermined amount of time.\n" }, { "info": { "name": "Creates a new session in a bastion.", "type": "http" }, "http": { "method": "POST", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/sessions", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new session in a bastion. A bastion session lets authorized users connect to a target resource for a predetermined amount of time. The Bastion service recognizes two types of sessions, managed SSH sessions and SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.\n" }, { "info": { "name": "Retrieves a session.", "type": "http" }, "http": { "method": "GET", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/sessions/:sessionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the session." } ] }, "docs": "Retrieves a session identified by the session ID. A bastion session lets authorized users connect to a target resource for a predetermined amount of time." }, { "info": { "name": "Updates the session.", "type": "http" }, "http": { "method": "PUT", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/sessions/:sessionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the session identified by the session ID. A bastion session lets authorized users connect to a target resource for a predetermined amount of time." }, { "info": { "name": "Deletes a session.", "type": "http" }, "http": { "method": "DELETE", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/sessions/:sessionId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sessionId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the session." } ] }, "docs": "Deletes a session identified by the session ID." }, { "info": { "name": "List Work Requests.", "type": "http" }, "http": { "method": "GET", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/workRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The unique identifier (OCID) 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." } ] }, "docs": "Lists the work requests in a compartment.\n" }, { "info": { "name": "Get Work Request Status.", "type": "http" }, "http": { "method": "GET", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/workRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the asynchronous request." } ] }, "docs": "Gets the status of the work request with the given ID." }, { "info": { "name": "Lists work request errors.", "type": "http" }, "http": { "method": "GET", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/workRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the asynchronous request." }, { "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." } ] }, "docs": "Return a (paginated) list of errors for a given work request.\n" }, { "info": { "name": "Lists work request logs.", "type": "http" }, "http": { "method": "GET", "url": "https://bastion.$region.oci.oraclecloud.com/20210331/workRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the asynchronous request." }, { "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." } ] }, "docs": "Return a (paginated) list of logs for a given work request.\n" } ] } ], "bundled": true }