List credentials
Returns all credentials in the authenticated user's organization.
Optionally filter by type (e.g. ?type=SnmpCommunity).
User API key (Bearer scp_u_...). Create in Platform > API Keys.
In: header
Query Parameters
Filter by credential type (e.g. SnmpCommunity, DockerProxy). Repeat for several.
Only credentials of one of these integrations. Repeat for several.
Only credentials whose type is in beta (true), stable (false), or both (repeat it).
Sent empty, matches none.
Only credentials whose type reads an unpublished API (true), a published one (false),
or both (repeat it). Sent empty, matches none.
Only credentials whose type can be applied to one of these targets. Repeat for several.
Only file and socket credentials for one of these daemon OS families. Repeat for several.
Only credentials assigned to one of these sites. Repeat for several.
Filter by tag IDs (returns credentials that have ANY of the specified tags)
Tag sets the credential must hold one tag from each of. Each entry is a comma-separated list of tag ids. One entry per tag group the list is filtered by.
Free-text search. Case-insensitive substring match against the name and description.
Primary ordering field (used for grouping). Always sorts ASC to keep groups together.
Secondary ordering field (sorting within groups or standalone sort).
Group by the tag each row holds from this tag group. Takes the place of group_by.
Sort by the position of the tag each row holds from this tag group. Takes the place of
order_by.
Direction for order_by field (group_by always uses ASC).
Maximum number of results to return (1-1000, default: 50). Use 0 for no limit.
Number of results to skip. Default: 0.
Response Body
application/json
curl -X GET "https://example.com/api/v1/credentials"{
"data": [
{
"assigned_site_ids": [
"6604c96d-f10b-465d-898b-5d4cb60cc0d7"
],
"credential_type": {
"community": {
"mode": "Inline",
"value": "string"
},
"type": "SnmpCommunity"
},
"description": "string",
"host_assignments": [
{
"host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b",
"ip_address_ids": [
"c2bc70c8-b7ad-480c-92cd-16dcad15753f"
]
}
],
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"tags": [
"a424dc99-d215-4281-ad2d-a3a9bc179925"
],
"daemon_os": "Unix",
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_default": true,
"updated_at": "2019-08-24T14:15:22Z"
}
],
"meta": {
"api_version": 1,
"pagination": {
"has_more": true,
"limit": 50,
"offset": 0,
"total_count": 142
},
"server_version": "0.19.4"
},
"success": true,
"error": "string"
}Product names and logos are trademarks of their respective owners. See credits.