Skip to content

GitHub: Agents schemas

4 GitHub schemas with complete fields and constraints.

← Agents operations · All schemas

Create an organization variable — agents agents Create Org Variable — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe name of the variable.
selected_repository_idsarrayOptionalAn array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.
selected_repository_ids[]integerEach item
valuestringRequired within parentThe value of the variable.
visibilitystringRequired within parentThe type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.
One of: all, private, selected

Get an organization secret — agents agents Get Org Secret — response body

FieldTypePresenceDescription and constraints
$objectRootSecrets for GitHub Actions for an organization.
created_atstringRequired within parentFormat: date-time
namestringRequired within parentThe name of the secret.
selected_repositories_urlstringOptionalFormat: uri
updated_atstringRequired within parentFormat: date-time
visibilitystringRequired within parentVisibility of a secret
Known values: all, private, selected

Get an organization variable — agents agents Get Org Variable — response body

FieldTypePresenceDescription and constraints
$objectRootOrganization variable for GitHub Actions.
created_atstringRequired within parentThe date and time at which the variable was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
Format: date-time
namestringRequired within parentThe name of the variable.
selected_repositories_urlstringOptionalFormat: uri
updated_atstringRequired within parentThe date and time at which the variable was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.
Format: date-time
valuestringRequired within parentThe value of the variable.
visibilitystringRequired within parentVisibility of a variable
Known values: all, private, selected

Update an organization variable — agents agents Update Org Variable — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
namestringOptionalThe name of the variable.
selected_repository_idsarrayOptionalAn array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.
selected_repository_ids[]integerEach item
valuestringOptionalThe value of the variable.
visibilitystringOptionalThe type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.
One of: all, private, selected

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.