PUpuppet
Profiles

Retrieve a list of custom profiles.

To use this endpoint, you must have one of the following roles: comply-admin comply-operator comply-viewer

get/v1/custom-profiles

Request

Query parameters

offsetinteger

The offset where list should start response at.

limitinteger

The offset where list should start response at.

Response

CustomProfilesListResponse is the response for a custom profiles list.

limitinteger

If specified limit, you retrieve a subset of records limited to the given value..

nextstring nullable

Next page value .

offsetinteger

Offset is the position in the dataset of a particular record. By specifying offset, you retrieve a subset of records starting with the offset value.

totalinteger required

Total number of records.

Example response

{
  "data": [
    {
      "id": 123,
      "name": "Custom Profile Name",
      "profile": {
        "benchmark": {
          "id": 123,
          "name": "3.1.2 CIS CentOS Linux 7"
        },
        "id": 123,
        "name": "Level 1 - Server"
      }
    }
  ],
  "limit": 10,
  "next": "/api/public/v_/_api_?offset=10&limit=10",
  "total": 123
}

Changes

No recorded changes to this operation across all 1 revision of this API.