{ "opencollection": "1.0.0", "info": { "name": "Secret Server Rest Activations SecretDependencies API", "version": "11.7.2" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "SecretDependencies", "type": "folder" }, "items": [ { "info": { "name": "Update Secret Dependency", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secret-dependencies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Secret Dependency ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Secret Dependency and returns the model" }, { "info": { "name": "Delete Secret Dependency", "type": "http" }, "http": { "method": "DELETE", "url": "/SecretServer/api/v1/secret-dependencies/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Secret Dependency ID" } ] }, "docs": "Delete a Secret Dependency by ID" }, { "info": { "name": "Get Secret Dependency Groups for a Secret", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-dependencies/groups/:secretId", "params": [ { "name": "secretId", "value": "", "type": "path", "description": "Secret ID" } ] }, "docs": "Get Secret Dependency Groups for a Secret" }, { "info": { "name": "Create Secret Dependency Group", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-dependencies/groups/:secretId", "params": [ { "name": "secretId", "value": "", "type": "path", "description": "Secret ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Secret Dependency Group and returns the model" }, { "info": { "name": "Update Secret Dependency Group", "type": "http" }, "http": { "method": "PUT", "url": "/SecretServer/api/v1/secret-dependencies/groups/:secretId", "params": [ { "name": "secretId", "value": "", "type": "path", "description": "Id of Secret to assign to Dependency Group." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Secret Dependency Group" }, { "info": { "name": "Get Scripts that are possible to use for Dependencies", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-dependencies/scripts" }, "docs": "Get Scripts that are possible to use for Dependencies" }, { "info": { "name": "Get Dependency Templates", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-dependencies/templates" }, "docs": "Get Dependency Templates" }, { "info": { "name": "Get Secret Dependency", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-dependencies/:secretDependencyId", "params": [ { "name": "secretDependencyId", "value": "", "type": "path", "description": "Secret Dependency ID" } ] }, "docs": "Gets a Secret Dependency and returns the Secret Dependency Model" }, { "info": { "name": "Search Secret Dependencies", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-dependencies", "params": [ { "name": "filter.groupId", "value": "", "type": "query", "description": "Filter by group id" }, { "name": "filter.includeInactive", "value": "", "type": "query", "description": "Whether or not to include inactive Secret Depenencies" }, { "name": "filter.lastRunStatus", "value": "", "type": "query", "description": "Filter by last dependency result status" }, { "name": "filter.searchText", "value": "", "type": "query", "description": "Search in the title / name and machine fields" }, { "name": "filter.secretId", "value": "", "type": "query", "description": "The Secret Id to filter on" }, { "name": "filter.templateId", "value": "", "type": "query", "description": "Filter by dependency template id" }, { "name": "skip", "value": "", "type": "query", "description": "Number of records to skip before taking results" }, { "name": "sortBy[0].direction", "value": "", "type": "query", "description": "Sort direction" }, { "name": "sortBy[0].name", "value": "", "type": "query", "description": "Sort field name" }, { "name": "sortBy[0].priority", "value": "", "type": "query", "description": "Priority index. Sorts with lower values are executed earlier" }, { "name": "take", "value": "", "type": "query", "description": "Maximum number of records to include in results" } ] }, "docs": "Search, filter, sort, and page Secret Dependencies on a Secret" }, { "info": { "name": "Create Secret Dependency", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-dependencies", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Secret Dependency and returns the model" }, { "info": { "name": "Get Secret Dependency run task status", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-dependencies/run/:identifier", "params": [ { "name": "identifier", "value": "", "type": "path", "description": "Task identifier" } ] }, "docs": "Gets a Secret Dependency run task status" }, { "info": { "name": "Get Secret Dependency Stub", "type": "http" }, "http": { "method": "GET", "url": "/SecretServer/api/v1/secret-dependencies/stub", "params": [ { "name": "scriptId", "value": "", "type": "query", "description": "The Id of the Script that this Dependency will Run. Only provide this value if the Dependency is running a script directly, and ensure that the type of the script matches the TypeId value passed in." }, { "name": "secretId", "value": "", "type": "query", "description": "The Id of the Secret that this Dependency will appear on" }, { "name": "templateId", "value": "", "type": "query", "description": "The Id of the Dependency Template that this Dependecy will be modeled on. Only provide this value if the Dependency is based on a Template." }, { "name": "typeId", "value": "", "type": "query", "description": "The Id of the Dependency Type that this Dependecy will be modeled on. Only provide this value if the Dependency is a running a script directly and is NOT based on a Dependency Template. Valid Values: PowershellScript = 7, SshScript = 8, SqlScript = 9" } ] }, "docs": "Return the default values for a new Secret Dependency" }, { "info": { "name": "Run Dependencies", "type": "http" }, "http": { "method": "POST", "url": "/SecretServer/api/v1/secret-dependencies/run", "body": { "type": "json", "data": "{}" } }, "docs": "Runs the list of dependencies and retruns an identifier that can be used to collect the status." } ] } ], "bundled": true }