{ "opencollection": "1.0.0", "info": { "name": "API Gateway API", "version": "20190501" }, "items": [ { "info": { "name": "apiGateway", "type": "folder" }, "items": [ { "info": { "name": "Gets a list of all APIs in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/apis", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ocid 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": "A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE`\n" }, { "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'. The default order depends on the sortBy value." }, { "name": "sortBy", "value": "", "type": "query", "description": "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" } ] }, "docs": "Returns a list of APIs.\n" }, { "info": { "name": "Creates a new API", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/apis", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new API.\n" }, { "info": { "name": "Get API", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/apis/:apiId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The ocid of the API." } ] }, "docs": "Gets an API by identifier." }, { "info": { "name": "Update the API by the identifier", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20190501/apis/:apiId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The ocid of the API." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the API with the given identifier." }, { "info": { "name": "Delete an API.", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20190501/apis/:apiId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The ocid of the API." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the API with the given identifier." }, { "info": { "name": "Adds a lock to a Api resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/apis/:apiId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The ocid of the API." } ] }, "docs": "Adds a lock to a Api resource." }, { "info": { "name": "Change the API compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/apis/:apiId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The ocid of the API." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the API compartment." }, { "info": { "name": "Removes a lock to a Api resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/apis/:apiId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The ocid of the API." } ] }, "docs": "Removes a lock from a Api resource." }, { "info": { "name": "Get raw API content", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/apis/:apiId/content", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" }, { "name": "range", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The ocid of the API." } ] }, "docs": "Get the raw API content." }, { "info": { "name": "Get API Deployment specification based on the API.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/apis/:apiId/deploymentSpecification", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The ocid of the API." } ] }, "docs": "Gets an API Deployment specification by identifier." }, { "info": { "name": "Get API content", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/apis/:apiId/validations", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "apiId", "value": "", "type": "path", "description": "The ocid of the API." } ] }, "docs": "Gets the API validation results." }, { "info": { "name": "Gets a list of all Certificates in a compartment", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/certificates", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The ocid 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": "A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE` or `DELETED`\n" }, { "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'. The default order depends on the sortBy value." }, { "name": "sortBy", "value": "", "type": "query", "description": "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" } ] }, "docs": "Returns a list of certificates.\n" }, { "info": { "name": "Creates a new Certificate", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/certificates", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Certificate.\n" }, { "info": { "name": "Get Certificate", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/certificates/:certificateId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The ocid of the certificate." } ] }, "docs": "Gets a certificate by identifier." }, { "info": { "name": "Update Certificate by the identifier", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20190501/certificates/:certificateId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The ocid of the certificate." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a certificate with the given identifier" }, { "info": { "name": "Delete a provisioned Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20190501/certificates/:certificateId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The ocid of the certificate." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes the certificate with the given identifier." }, { "info": { "name": "Adds a lock to a Certificate resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/certificates/:certificateId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The ocid of the certificate." } ] }, "docs": "Adds a lock to a Certificate resource." }, { "info": { "name": "Change the certificate compartment.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/certificates/:certificateId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The ocid of the certificate." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Changes the certificate compartment." }, { "info": { "name": "Removes a lock to a Certificate resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/certificates/:certificateId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "certificateId", "value": "", "type": "path", "description": "The ocid of the certificate." } ] }, "docs": "Removes a lock from a Certificate resource." }, { "info": { "name": "Lists available SDK target languages.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/sdkLanguageTypes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "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": "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'. The default order depends on the sortBy value." }, { "name": "sortBy", "value": "", "type": "query", "description": "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" }, { "name": "compartmentId", "value": "", "type": "query", "description": "The ocid of the compartment in which to list resources." } ] }, "docs": "Lists programming languages in which SDK can be generated." }, { "info": { "name": "Lists SDKs", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/sdks", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sdkId", "value": "", "type": "query", "description": "The ocid of the SDK. This value must be present unless apiId is present." }, { "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": "A filter to return only resources that match the given lifecycle state.\n\nExample: `ACTIVE` or `DELETED`\n" }, { "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'. The default order depends on the sortBy value." }, { "name": "sortBy", "value": "", "type": "query", "description": "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" }, { "name": "apiId", "value": "", "type": "query", "description": "The ocid of the API. This value must be present unless sdkId is present." } ] }, "docs": "Returns list of generated SDKs." }, { "info": { "name": "Creates an SDK", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/sdks", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new SDK." }, { "info": { "name": "Downloadable link for the SDK.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20190501/sdks/:sdkId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sdkId", "value": "", "type": "path", "description": "The ocid of the SDK." } ] }, "docs": "Return object store downloadable URL and metadata." }, { "info": { "name": "Update the SDK by the identifier", "type": "http" }, "http": { "method": "PUT", "url": "http://127.0.0.1/20190501/sdks/:sdkId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "sdkId", "value": "", "type": "path", "description": "The ocid of the SDK." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the SDK with the given identifier." }, { "info": { "name": "Deletes SDK", "type": "http" }, "http": { "method": "DELETE", "url": "http://127.0.0.1/20190501/sdks/:sdkId", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "sdkId", "value": "", "type": "path", "description": "The ocid of the SDK." }, { "name": "isLockOverride", "value": "", "type": "query", "description": "Whether to override locks (if any exist)." } ] }, "docs": "Deletes provided SDK." }, { "info": { "name": "Adds a lock to a Sdk resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/sdks/:sdkId/actions/addLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "sdkId", "value": "", "type": "path", "description": "The ocid of the SDK." } ] }, "docs": "Adds a lock to a Sdk resource." }, { "info": { "name": "Removes a lock to a Sdk resource.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20190501/sdks/:sdkId/actions/removeLock", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "if-match", "value": "" } ], "params": [ { "name": "sdkId", "value": "", "type": "path", "description": "The ocid of the SDK." } ] }, "docs": "Removes a lock from a Sdk resource." } ] } ], "bundled": true }