{ "opencollection": "1.0.0", "info": { "name": "Catchpoint REST API v2.0 Account Credentials API", "version": "2.0" }, "items": [ { "info": { "name": "Credentials", "type": "folder" }, "items": [ { "info": { "name": "Return credential details by the IDs passed", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/library/credentials/:ids", "params": [ { "name": "ids", "value": "", "type": "path", "description": "Comma separated list of credential IDs" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return credential details by the IDs passed" }, { "info": { "name": "Delete credentials based on the list of the IDs", "type": "http" }, "http": { "method": "DELETE", "url": "/api/v2/library/credentials/:ids", "params": [ { "name": "ids", "value": "", "type": "path", "description": "Comma separated list of credential IDs" } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete credentials based on the list of the IDs" }, { "info": { "name": "Return credential details by the parameters passed", "type": "http" }, "http": { "method": "GET", "url": "/api/v2/library/credentials", "params": [ { "name": "credentialType", "value": "", "type": "query", "description": "Credential Type ID (Password = 0, Token = 1, Certificate = 2)." }, { "name": "usedByItem", "value": "", "type": "query", "description": "Comma separated list of product or folder or test IDs. Get credentials that the items use." }, { "name": "contactIds", "value": "", "type": "query", "description": "Comma separated list of contact IDs. Get credentials that the provided contacts have access to." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Return credential details by the parameters passed" }, { "info": { "name": "Create a Credential based on the PostData.", "type": "http" }, "http": { "method": "POST", "url": "/api/v2/library/credentials", "params": [ { "name": "objectDetails", "value": "", "type": "query", "description": "Set to true to return the created object in the response body, otherwise the response body will only return created object ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "To get payload for creating a new credential and to get the created credential details refer InternalLink[Credentials by ID Endpoint,operations-tag-Credentials,operations-Credentials-get_v2_credentials__ids_]. Pass “0” for credential ID to create a new credential." }, { "info": { "name": "Update an existing library credential based on the request body", "type": "http" }, "http": { "method": "PATCH", "url": "/api/v2/library/credentials/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Library Credential ID" }, { "name": "objectDetails", "value": "", "type": "query", "description": "Set it to true to return the updated object in the response body else the response body will only return updated object ID." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "**Request:**\r\n \r\nOnly the property to be updated can be passed in the request body instead of the whole object. The update request body requires a total of three keys to be filled with appropriate value as listed below:\r\n* **value** – The value property provides the new value.\r\n \r\n* **path** – The path property indicates the element to update. The entire path with slashes needs to be provided here. Example: /status/id\r\n \r\n* **op** – The op property indicates the " } ] } ], "bundled": true }