GIgitguardian
Internal Secret Incidents

Retrieve the remediation workflow

Retrieve the remediation workflow displayed for secret incidents.

Returns the custom remediation workflow configured for the account when one exists and is active, otherwise a default workflow. For the default workflow, id, gg_created_at and gg_updated_at are omitted.

get/v1/remediation-workflow

Request

  • Base URL
    https://api.gitguardian.com
  • URL
    https://api.gitguardian.com/v1/remediation-workflow
  • Auth
    HTTP bearer

Response

Remediation Workflow

idinteger

Identifier of the workflow. Absent for the default workflow.

account_idinteger required

Identifier of the account owning the workflow.

created_atstring date-time

Creation date. Absent for the default workflow.

updated_atstring date-time

Last update date. Absent for the default workflow.

Example response

{
  "id": 42,
  "account_id": 1,
  "steps": [
    {
      "title": "Rotate & revoke the leaked secret",
      "description": "A secret that has been leaked should be considered compromised.",
      "link": {
        "text": "Read the documentation",
        "url": "https://docs.gitguardian.com"
      }
    }
  ],
  "created_at": "2024-06-01T10:00:00Z"
}

Changes

No recorded changes to this operation across all 35 revisions of this API.