Back to Gitlabhq

Compliance and policy settings API

doc/api/compliance_policy_settings.md

18.11.22.0 KB
Original Source

{{< details >}}

  • Tier: Ultimate
  • Offering: GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

{{< /history >}}

Use this API to interact with the security policy settings for your GitLab instance.

Prerequisites:

  • You must have administrator access to the instance.
  • Your instance must have the Ultimate tier to use security policies.

Retrieve security policy settings

Retrieves the current security policy settings for this GitLab instance.

plaintext
GET /admin/security/compliance_policy_settings
shell
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/security/compliance_policy_settings"

Example response:

json
{
  "csp_namespace_id": 42
}

When no CSP namespace is configured:

json
{
  "csp_namespace_id": null
}

Update security policy settings

Updates the security policy settings for this GitLab instance.

plaintext
PUT /admin/security/compliance_policy_settings
AttributeTypeRequiredDescription
csp_namespace_idintegeryesID of the group designated to centrally manage security policies. Must be a top-level group. Set to null to clear the setting.
shell
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --data '{"csp_namespace_id": 42}' \
  --url "https://gitlab.example.com/api/v4/admin/security/compliance_policy_settings"

Example response:

json
{
  "csp_namespace_id": 42
}