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:

NameDescription
enginename of engine
typename of type of secret
orgname of organization
namename of repository or team
secretname of secret

Permissions

COMING SOON!

Responses

Status CodeDescription
200indicates the request has succeeded
401indicates the user does not have proper permissions

Sample

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,
      "labeled": false,
      "unlabeled": false
    },
    "deployment": {
      "created": true
    },
    "comment": {
      "created": false,
      "edited": false
    },
    "schedule": {
      "run": false
    }
  },
  "created_at": 1641314085,
  "created_by": "octokitty",
  "updated_at": 1641314500,
  "updated_by": "octocat"
}