REST-API-Endpunkte für GitHub-Actions-Variablen

About variables in GitHub Actions

You can use the REST API to create, update, delete, and retrieve information about variables that can be used in workflows in GitHub Actions. Variables allow you to store non-sensitive information, such as a username, in your repository, repository environments, or organization. For more information, see "Store information in variables" in the GitHub Actions documentation.

List organization variables

Lists all organization variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

Differenzierte Zugriffstoken für "List organization variables"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" organization permissions (read)

Parameter für „List organization variables“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 30). For more information, see "Using pagination in the REST API." Standard: `10`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List organization variables“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List organization variables“

Anforderungsbeispiel

get/orgs/{org}/actions/variables

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/actions/variables

Response

Status: 200

{
  "total_count": 3,
  "variables": [
    {
      "name": "USERNAME",
      "value": "octocat",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z",
      "visibility": "private"
    },
    {
      "name": "ACTIONS_RUNNER_DEBUG",
      "value": true,
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z",
      "visibility": "all"
    },
    {
      "name": "ADMIN_EMAIL",
      "value": "octocat@github.com",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z",
      "visibility": "selected",
      "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories"
    }
  ]
}

Create an organization variable

Creates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Create an organization variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" organization permissions (write)

Parameter für „Create an organization variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Textparameter
Name, type, BESCHREIBUNG
`name` string Erforderlich The name of the variable.
`value` string Erforderlich The value of the variable.
`visibility` string Erforderlich The 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. Kann eine der Folgenden sein: `all`, `private`, `selected`
`selected_repository_ids` array of integers An 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`.

HTTP-Antwortstatuscodes für „Create an organization variable“

Statuscode	BESCHREIBUNG
`201`	Response when creating a variable

Codebeispiele für „Create an organization variable“

Anforderungsbeispiel

post/orgs/{org}/actions/variables

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/actions/variables \
  -d '{"name":"USERNAME","value":"octocat","visibility":"selected","selected_repository_ids":[1296269,1296280]}'

Response when creating a variable

Status: 201

Get an organization variable

Gets a specific variable in an organization.

The authenticated user must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Get an organization variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" organization permissions (read)

Parameter für „Get an organization variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`name` string Erforderlich The name of the variable.

HTTP-Antwortstatuscodes für „Get an organization variable“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „Get an organization variable“

Anforderungsbeispiel

get/orgs/{org}/actions/variables/{name}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/actions/variables/NAME

Response

Status: 200

{
  "name": "USERNAME",
  "value": "octocat",
  "created_at": "2019-08-10T14:59:22Z",
  "updated_at": "2020-01-10T14:59:22Z",
  "visibility": "selected",
  "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/variables/USERNAME/repositories"
}

Update an organization variable

Updates an organization variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

Differenzierte Zugriffstoken für "Update an organization variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" organization permissions (write)

Parameter für „Update an organization variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`name` string Erforderlich The name of the variable.

Textparameter
Name, type, BESCHREIBUNG
`name` string The name of the variable.
`value` string The value of the variable.
`visibility` string The 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. Kann eine der Folgenden sein: `all`, `private`, `selected`
`selected_repository_ids` array of integers An 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`.

HTTP-Antwortstatuscodes für „Update an organization variable“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Update an organization variable“

Anforderungsbeispiel

patch/orgs/{org}/actions/variables/{name}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/actions/variables/NAME \
  -d '{"name":"USERNAME","value":"octocat","visibility":"selected","selected_repository_ids":[1296269,1296280]}'

Response

Status: 204

Delete an organization variable

Deletes an organization variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Delete an organization variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" organization permissions (write)

Parameter für „Delete an organization variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`name` string Erforderlich The name of the variable.

HTTP-Antwortstatuscodes für „Delete an organization variable“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Delete an organization variable“

Anforderungsbeispiel

delete/orgs/{org}/actions/variables/{name}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/actions/variables/NAME

Response

Status: 204

List selected repositories for an organization variable

Lists all repositories that can access an organization variable that is available to selected repositories.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

Differenzierte Zugriffstoken für "List selected repositories for an organization variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" organization permissions (read)

Parameter für „List selected repositories for an organization variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`name` string Erforderlich The name of the variable.

Abfrageparameter
Name, type, BESCHREIBUNG
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`

HTTP-Antwortstatuscodes für „List selected repositories for an organization variable“

Statuscode	BESCHREIBUNG
`200`	OK
`409`	Response when the visibility of the variable is not set to `selected`

Codebeispiele für „List selected repositories for an organization variable“

Anforderungsbeispiel

get/orgs/{org}/actions/variables/{name}/repositories

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/actions/variables/NAME/repositories

Response

Status: 200

{
  "total_count": 1,
  "repositories": [
    {
      "id": 1296269,
      "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5",
      "name": "Hello-World",
      "full_name": "octocat/Hello-World",
      "owner": {
        "login": "octocat",
        "id": 1,
        "node_id": "MDQ6VXNlcjE=",
        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
        "gravatar_id": "",
        "url": "https://api.github.com/users/octocat",
        "html_url": "https://github.com/octocat",
        "followers_url": "https://api.github.com/users/octocat/followers",
        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
        "organizations_url": "https://api.github.com/users/octocat/orgs",
        "repos_url": "https://api.github.com/users/octocat/repos",
        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
        "received_events_url": "https://api.github.com/users/octocat/received_events",
        "type": "User",
        "site_admin": false
      },
      "private": false,
      "html_url": "https://github.com/octocat/Hello-World",
      "description": "This your first repo!",
      "fork": false,
      "url": "https://api.github.com/repos/octocat/Hello-World",
      "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}",
      "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}",
      "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}",
      "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}",
      "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}",
      "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}",
      "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}",
      "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}",
      "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}",
      "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors",
      "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments",
      "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads",
      "events_url": "https://api.github.com/repos/octocat/Hello-World/events",
      "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks",
      "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}",
      "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}",
      "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}",
      "git_url": "git:github.com/octocat/Hello-World.git",
      "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}",
      "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}",
      "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}",
      "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}",
      "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}",
      "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages",
      "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges",
      "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}",
      "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}",
      "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}",
      "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}",
      "ssh_url": "git@github.com:octocat/Hello-World.git",
      "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers",
      "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}",
      "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers",
      "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription",
      "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags",
      "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams",
      "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}",
      "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks"
    }
  ]
}

Set selected repositories for an organization variable

Replaces all repositories for an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

Differenzierte Zugriffstoken für "Set selected repositories for an organization variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" organization permissions (write)

Parameter für „Set selected repositories for an organization variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`name` string Erforderlich The name of the variable.

Textparameter
Name, type, BESCHREIBUNG
`selected_repository_ids` array of integers Erforderlich The IDs of the repositories that can access the organization variable.

HTTP-Antwortstatuscodes für „Set selected repositories for an organization variable“

Statuscode	BESCHREIBUNG
`204`	No Content
`409`	Response when the visibility of the variable is not set to `selected`

Codebeispiele für „Set selected repositories for an organization variable“

Anforderungsbeispiel

put/orgs/{org}/actions/variables/{name}/repositories

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/actions/variables/NAME/repositories \
  -d '{"selected_repository_ids":[64780797]}'

Response

Status: 204

Add selected repository to an organization variable

Adds a repository to an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Add selected repository to an organization variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" organization permissions (write) and "Metadata" repository permissions (read)

Parameter für „Add selected repository to an organization variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`name` string Erforderlich The name of the variable.
`repository_id` integer Erforderlich

HTTP-Antwortstatuscodes für „Add selected repository to an organization variable“

Statuscode	BESCHREIBUNG
`204`	No Content
`409`	Response when the visibility of the variable is not set to `selected`

Codebeispiele für „Add selected repository to an organization variable“

Anforderungsbeispiel

put/orgs/{org}/actions/variables/{name}/repositories/{repository_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/actions/variables/NAME/repositories/REPOSITORY_ID

Response

Status: 204

Remove selected repository from an organization variable

Removes a repository from an organization variable that is available to selected repositories. Organization variables that are available to selected repositories have their visibility field set to selected.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint. If the repository is private, the repo scope is also required.

Differenzierte Zugriffstoken für "Remove selected repository from an organization variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" organization permissions (write) and "Metadata" repository permissions (read)

Parameter für „Remove selected repository from an organization variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`name` string Erforderlich The name of the variable.
`repository_id` integer Erforderlich

HTTP-Antwortstatuscodes für „Remove selected repository from an organization variable“

Statuscode	BESCHREIBUNG
`204`	No Content
`409`	Response when the visibility of the variable is not set to `selected`

Codebeispiele für „Remove selected repository from an organization variable“

Anforderungsbeispiel

delete/orgs/{org}/actions/variables/{name}/repositories/{repository_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/actions/variables/NAME/repositories/REPOSITORY_ID

Response

Status: 204

List repository organization variables

Lists all organization variables shared with a repository.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "List repository organization variables"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (read)

Parameter für „List repository organization variables“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 30). For more information, see "Using pagination in the REST API." Standard: `10`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List repository organization variables“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List repository organization variables“

Anforderungsbeispiel

get/repos/{owner}/{repo}/actions/organization-variables

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/actions/organization-variables

Response

Status: 200

{
  "total_count": 2,
  "variables": [
    {
      "name": "USERNAME",
      "value": "octocat",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z"
    },
    {
      "name": "EMAIL",
      "value": "octocat@github.com",
      "created_at": "2020-01-10T10:59:22Z",
      "updated_at": "2020-01-11T11:59:22Z"
    }
  ]
}

List repository variables

Lists all repository variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "List repository variables"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (read)

Parameter für „List repository variables“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 30). For more information, see "Using pagination in the REST API." Standard: `10`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List repository variables“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List repository variables“

Anforderungsbeispiel

get/repos/{owner}/{repo}/actions/variables

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/actions/variables

Response

Status: 200

{
  "total_count": 2,
  "variables": [
    {
      "name": "USERNAME",
      "value": "octocat",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z"
    },
    {
      "name": "EMAIL",
      "value": "octocat@github.com",
      "created_at": "2020-01-10T10:59:22Z",
      "updated_at": "2020-01-11T11:59:22Z"
    }
  ]
}

Create a repository variable

Creates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Create a repository variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (write)

Parameter für „Create a repository variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.

Textparameter
Name, type, BESCHREIBUNG
`name` string Erforderlich The name of the variable.
`value` string Erforderlich The value of the variable.

HTTP-Antwortstatuscodes für „Create a repository variable“

Statuscode	BESCHREIBUNG
`201`	Created

Codebeispiele für „Create a repository variable“

Anforderungsbeispiel

post/repos/{owner}/{repo}/actions/variables

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/actions/variables \
  -d '{"name":"USERNAME","value":"octocat"}'

Response

Status: 201

Get a repository variable

Gets a specific variable in a repository.

The authenticated user must have collaborator access to the repository to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Get a repository variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (read)

Parameter für „Get a repository variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`name` string Erforderlich The name of the variable.

HTTP-Antwortstatuscodes für „Get a repository variable“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „Get a repository variable“

Anforderungsbeispiel

get/repos/{owner}/{repo}/actions/variables/{name}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/actions/variables/NAME

Response

Status: 200

{
  "name": "USERNAME",
  "value": "octocat",
  "created_at": "2021-08-10T14:59:22Z",
  "updated_at": "2022-01-10T14:59:22Z"
}

Update a repository variable

Updates a repository variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Update a repository variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (write)

Parameter für „Update a repository variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`name` string Erforderlich The name of the variable.

Textparameter
Name, type, BESCHREIBUNG
`name` string The name of the variable.
`value` string The value of the variable.

HTTP-Antwortstatuscodes für „Update a repository variable“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Update a repository variable“

Anforderungsbeispiel

patch/repos/{owner}/{repo}/actions/variables/{name}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/actions/variables/NAME \
  -d '{"name":"USERNAME","value":"octocat"}'

Response

Status: 204

Delete a repository variable

Deletes a repository variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Delete a repository variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (write)

Parameter für „Delete a repository variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`name` string Erforderlich The name of the variable.

HTTP-Antwortstatuscodes für „Delete a repository variable“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Delete a repository variable“

Anforderungsbeispiel

delete/repos/{owner}/{repo}/actions/variables/{name}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/actions/variables/NAME

Response

Status: 204

List environment variables

Lists all environment variables.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "List environment variables"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (read) and "Environments" repository permissions (read)

Parameter für „List environment variables“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 30). For more information, see "Using pagination in the REST API." Standard: `10`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List environment variables“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List environment variables“

Anforderungsbeispiel

get/repos/{owner}/{repo}/environments/{environment_name}/variables

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables

Response

Status: 200

{
  "total_count": 2,
  "variables": [
    {
      "name": "USERNAME",
      "value": "octocat",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z"
    },
    {
      "name": "EMAIL",
      "value": "octocat@github.com",
      "created_at": "2020-01-10T10:59:22Z",
      "updated_at": "2020-01-11T11:59:22Z"
    }
  ]
}

Create an environment variable

Create an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Create an environment variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (write) and "Environments" repository permissions (write)

Parameter für „Create an environment variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.

Textparameter
Name, type, BESCHREIBUNG
`name` string Erforderlich The name of the variable.
`value` string Erforderlich The value of the variable.

HTTP-Antwortstatuscodes für „Create an environment variable“

Statuscode	BESCHREIBUNG
`201`	Created

Codebeispiele für „Create an environment variable“

Anforderungsbeispiel

post/repos/{owner}/{repo}/environments/{environment_name}/variables

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables \
  -d '{"name":"USERNAME","value":"octocat"}'

Response

Status: 201

Get an environment variable

Gets a specific variable in an environment.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Get an environment variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (read) and "Environments" repository permissions (read)

Parameter für „Get an environment variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
`name` string Erforderlich The name of the variable.

HTTP-Antwortstatuscodes für „Get an environment variable“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „Get an environment variable“

Anforderungsbeispiel

get/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables/NAME

Response

Status: 200

{
  "name": "USERNAME",
  "value": "octocat",
  "created_at": "2021-08-10T14:59:22Z",
  "updated_at": "2022-01-10T14:59:22Z"
}

Update an environment variable

Updates an environment variable that you can reference in a GitHub Actions workflow.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Update an environment variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (write) and "Environments" repository permissions (write)

Parameter für „Update an environment variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`name` string Erforderlich The name of the variable.
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.

Textparameter
Name, type, BESCHREIBUNG
`name` string The name of the variable.
`value` string The value of the variable.

HTTP-Antwortstatuscodes für „Update an environment variable“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Update an environment variable“

Anforderungsbeispiel

patch/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables/NAME \
  -d '{"name":"USERNAME","value":"octocat"}'

Response

Status: 204

Delete an environment variable

Deletes an environment variable using the variable name.

Authenticated users must have collaborator access to a repository to create, update, or read variables.

OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

Differenzierte Zugriffstoken für "Delete an environment variable"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Variables" repository permissions (write) and "Environments" repository permissions (write)

Parameter für „Delete an environment variable“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`owner` string Erforderlich The account owner of the repository. The name is not case sensitive.
`repo` string Erforderlich The name of the repository without the `.git` extension. The name is not case sensitive.
`name` string Erforderlich The name of the variable.
`environment_name` string Erforderlich The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.

HTTP-Antwortstatuscodes für „Delete an environment variable“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Delete an environment variable“

Anforderungsbeispiel

delete/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/repos/OWNER/REPO/environments/ENVIRONMENT_NAME/variables/NAME

Response

Status: 204