GET
/
v1
/
groups
/
{group_name}
Get a policy group by name
curl --request GET \
  --url https://api.app.chainloop.dev/v1/groups/{group_name} \
  --header 'Authorization: Bearer <token>'
{
  "version_references": [
    {
      "digest": "digest",
      "created_at": "2000-01-23T04:56:07.000Z"
    },
    {
      "digest": "digest",
      "created_at": "2000-01-23T04:56:07.000Z"
    }
  ],
  "inputs_json_schema": "inputs_json_schema",
  "organization_id": "organization_id",
  "builtin": true,
  "digest": "digest",
  "raw": {
    "format": "FORMAT_UNSPECIFIED",
    "body": "body"
  },
  "organization_name": "organization_name",
  "group": {
    "version_references": [
      {
        "digest": "digest",
        "created_at": "2000-01-23T04:56:07.000Z"
      },
      {
        "digest": "digest",
        "created_at": "2000-01-23T04:56:07.000Z"
      }
    ],
    "attestation": [
      {
        "with": {
          "key": "with"
        },
        "ref": "ref"
      },
      {
        "with": {
          "key": "with"
        },
        "ref": "ref"
      }
    ],
    "materials": [
      {
        "name": "name",
        "policies": [
          {
            "with": {
              "key": "with"
            },
            "ref": "ref"
          },
          {
            "with": {
              "key": "with"
            },
            "ref": "ref"
          }
        ],
        "type": "type"
      },
      {
        "name": "name",
        "policies": [
          {
            "with": {
              "key": "with"
            },
            "ref": "ref"
          },
          {
            "with": {
              "key": "with"
            },
            "ref": "ref"
          }
        ],
        "type": "type"
      }
    ],
    "raw_group": {
      "format": "FORMAT_UNSPECIFIED",
      "body": "body"
    },
    "builtin": true,
    "organization_id": "organization_id",
    "digest": "digest",
    "name": "name",
    "description": "description",
    "organization_name": "organization_name",
    "category": "category",
    "latest": true
  },
  "latest": true
}

Authorizations

​
Authorization
string
header
required

Bearer token for authentication

Path Parameters

​
group_name
string
required

The name of the policy group to retrieve

Query Parameters

​
digest
string

if set, it will return the policy with the given digest otherwise it will return the latest version

If set, returns the policy group with the given digest; otherwise returns the latest version

​
organization_name
string

Organization owning this policy group (empty for best effort fallback)

Organization owning this policy group (empty for best effort fallback)

Response

A successful response.

Response containing a policy group and its metadata

​
digest
string

The digest of the policy group

​
raw
object
Example:
{
  "format": "FORMAT_UNSPECIFIED",
  "body": "body"
}
​
group
object
Example:
{
  "version_references": [
    {
      "digest": "digest",
      "created_at": "2000-01-23T04:56:07.000Z"
    },
    {
      "digest": "digest",
      "created_at": "2000-01-23T04:56:07.000Z"
    }
  ],
  "attestation": [
    { "with": { "key": "with" }, "ref": "ref" },
    { "with": { "key": "with" }, "ref": "ref" }
  ],
  "materials": [
    {
      "name": "name",
      "policies": [
        { "with": { "key": "with" }, "ref": "ref" },
        { "with": { "key": "with" }, "ref": "ref" }
      ],
      "type": "type"
    },
    {
      "name": "name",
      "policies": [
        { "with": { "key": "with" }, "ref": "ref" },
        { "with": { "key": "with" }, "ref": "ref" }
      ],
      "type": "type"
    }
  ],
  "raw_group": {
    "format": "FORMAT_UNSPECIFIED",
    "body": "body"
  },
  "builtin": true,
  "organization_id": "organization_id",
  "digest": "digest",
  "name": "name",
  "description": "description",
  "organization_name": "organization_name",
  "category": "category",
  "latest": true
}
​
latest
boolean

Whether this is the latest version of the policy group (deprecated)

​
organization_id
string

ID of the organization owning this policy group (deprecated)

​
organization_name
string

Name of the organization owning this policy group

​
builtin
boolean

Whether this policy group is builtin (deprecated)

​
version_references
PolicyGroupReference represents the reference to a policy group version · object[]

References to all versions of this policy group (deprecated)

​
inputs_json_schema
string

JSON schema of the inputs required by the policy group