View

Learn how to inspect a secret.

Endpoint

GET  /api/v1/secrets/:engine/:type/:org/:name/:secret

Parameters

The following parameters are used to configure the endpoint:

Name	Description
`engine`	name of engine
`type`	name of type of secret
`org`	name of organization
`name`	name of repository or team
`secret`	name of secret

Permissions

COMING SOON!

Responses

Status Code	Description
`200`	indicates the request has succeeded
`401`	indicates the user does not have proper permissions

Sample

This section assumes you already know how to authenticate to the API.

To authenticate to the API, please review the authentication documentation.

Request

curl \
  -X GET \
  -H "Authorization: Bearer <token>" \
  "http://127.0.0.1:8080/api/v1/secrets/native/repo/github/octocat/foo"

Response

{
  "id": 1,
  "org": "github",
  "repo": "octocat",
  "team": "",
  "name": "foo",
  "value": "",
  "type": "repo",
  "images": ["alpine"],
  "events": ["push"],
  "allow_command": true,
  "allow_substitution": true,
  "allow_events": {
    "push": {
      "branch": true,
      "tag": true,
      "delete_branch": false,
      "delete_tag": false
    },
    "pull_request": {
      "opened": false,
      "edited": false,
      "synchronize": false,
      "reopened": false
    },
    "deployment": {
      "created": true
    },
    "comment": {
      "created": false,
      "edited": false
    },
    "schedule": {
      "run": false
    }
  },
  "created_at": 1641314085,
  "created_by": "octokitty",
  "updated_at": 1641314500,
  "updated_by": "octocat"
}

Last modified March 13, 2024: docs: update secrets allow_substitution API + CLI reference (#403) (8d454cd9)