GitHub Actions · Schema
GitHub Actions Secret
Represents an encrypted secret for GitHub Actions. The encrypted value is never returned by the API.
Properties
| Name | Type | Description |
|---|---|---|
| name | string | The name of the secret. |
| created_at | string | The date and time the secret was created. |
| updated_at | string | The date and time the secret was last updated. |
| visibility | string | The visibility scope of the secret (organization secrets only). |
| selected_repositories_url | string | The API URL to manage selected repositories for this secret (organization secrets with selected visibility only). |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://schema.github.com/actions/secret.json",
"title": "GitHub Actions Secret",
"description": "Represents an encrypted secret for GitHub Actions. The encrypted value is never returned by the API.",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the secret.",
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$",
"examples": ["AWS_ACCESS_KEY_ID", "NPM_TOKEN", "DEPLOY_KEY"]
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the secret was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The date and time the secret was last updated."
},
"visibility": {
"type": "string",
"description": "The visibility scope of the secret (organization secrets only).",
"enum": ["all", "private", "selected"]
},
"selected_repositories_url": {
"type": "string",
"format": "uri",
"description": "The API URL to manage selected repositories for this secret (organization secrets with selected visibility only)."
}
},
"required": ["name", "created_at", "updated_at"]
}