← All tags

Agents API Reference

No endpoints match your search.

List organization secrets

GET /orgs/{org}/agents/secrets

Lists all secrets available in an organization without revealing their

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

Get an organization public key

GET /orgs/{org}/agents/secrets/public-key

Gets your public key, which you need to encrypt secrets. You need to

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes

Get an organization secret

GET /orgs/{org}/agents/secrets/{secret_name}

Gets a single organization secret without revealing its encrypted value.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
secret_name	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
200	Response	yes

Create or update an organization secret

PUT /orgs/{org}/agents/secrets/{secret_name}

Creates or updates an organization secret with an encrypted value. Encrypt your secret using

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
secret_name	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
201	Response when creating a secret	yes
204	Response when updating a secret	no

Delete an organization secret

DELETE /orgs/{org}/agents/secrets/{secret_name}

Deletes a secret in an organization using the secret name.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
secret_name	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
204	Response	no

List selected repositories for an organization secret

GET /orgs/{org}/agents/secrets/{secret_name}/repositories

Lists all repositories that have been selected when the visibility

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
secret_name	path	yes	The name of the secret.
page	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

Set selected repositories for an organization secret

PUT /orgs/{org}/agents/secrets/{secret_name}/repositories

Replaces all repositories for an organization secret when the visibility

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
secret_name	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
204	Response	no

Add selected repository to an organization secret

PUT /orgs/{org}/agents/secrets/{secret_name}/repositories/{repository_id}

Adds a repository to an organization secret when the visibility for

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
secret_name	path	yes	The name of the secret.
repository_id	path	yes

Responses

Status	Description	Has JSON body
204	No Content when repository was added to the selected list	no
409	Conflict when visibility type is not set to selected	no

Remove selected repository from an organization secret

DELETE /orgs/{org}/agents/secrets/{secret_name}/repositories/{repository_id}

Removes a repository from an organization secret when the visibility

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
secret_name	path	yes	The name of the secret.
repository_id	path	yes

Responses

Status	Description	Has JSON body
204	Response when repository was removed from the selected list	no
409	Conflict when visibility type not set to selected	no

List organization variables

GET /orgs/{org}/agents/variables

Lists all agent variables available in an organization.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
per_page	query	no	The number of results per page (max 30). For more information, see "Using pagination in the REST API."
page	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

Create an organization variable

POST /orgs/{org}/agents/variables

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

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
201	Response when creating a variable	yes

Get an organization variable

GET /orgs/{org}/agents/variables/{name}

Gets a specific agent variable in an organization.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
name	path	yes	The name of the variable.

Responses

Status	Description	Has JSON body
200	Response	yes

Update an organization variable

PATCH /orgs/{org}/agents/variables/{name}

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

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
name	path	yes	The name of the variable.

Responses

Status	Description	Has JSON body
204	Response	no

Delete an organization variable

DELETE /orgs/{org}/agents/variables/{name}

Deletes an organization agent variable using the variable name.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
name	path	yes	The name of the variable.

Responses

Status	Description	Has JSON body
204	Response	no

List selected repositories for an organization variable

GET /orgs/{org}/agents/variables/{name}/repositories

Lists all repositories that can access an organization agent variable

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
name	path	yes	The name of the variable.
page	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
409	Response when the visibility of the variable is not set to selected	no

Set selected repositories for an organization variable

PUT /orgs/{org}/agents/variables/{name}/repositories

Replaces all repositories for an organization agent variable that is available

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
name	path	yes	The name of the variable.

Responses

Status	Description	Has JSON body
204	Response	no
409	Response when the visibility of the variable is not set to selected	no

Add selected repository to an organization variable

PUT /orgs/{org}/agents/variables/{name}/repositories/{repository_id}

Adds a repository to an organization agent variable that is available to selected repositories.

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
name	path	yes	The name of the variable.
repository_id	path	yes

Responses

Status	Description	Has JSON body
204	Response	no
409	Response when the visibility of the variable is not set to selected	no

Remove selected repository from an organization variable

DELETE /orgs/{org}/agents/variables/{name}/repositories/{repository_id}

Removes a repository from an organization agent variable that is

Parameters

Name	In	Required	Description
org	path	yes	The organization name. The name is not case sensitive.
name	path	yes	The name of the variable.
repository_id	path	yes

Responses

Status	Description	Has JSON body
204	Response	no
409	Response when the visibility of the variable is not set to selected	no

List repository organization secrets

GET /repos/{owner}/{repo}/agents/organization-secrets

Lists all organization secrets shared with a repository without revealing their encrypted

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List repository organization variables

GET /repos/{owner}/{repo}/agents/organization-variables

Lists all organization variables shared with a repository.

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
per_page	query	no	The number of results per page (max 30). For more information, see "Using pagination in the REST API."
page	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

List repository secrets

GET /repos/{owner}/{repo}/agents/secrets

Lists all secrets available in a repository without revealing their encrypted

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
per_page	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
page	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

Get a repository public key

GET /repos/{owner}/{repo}/agents/secrets/public-key

Gets your public key, which you need to encrypt secrets. You need to

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes

Get a repository secret

GET /repos/{owner}/{repo}/agents/secrets/{secret_name}

Gets a single repository secret without revealing its encrypted value.

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
secret_name	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
200	Response	yes

Create or update a repository secret

PUT /repos/{owner}/{repo}/agents/secrets/{secret_name}

Creates or updates a repository secret with an encrypted value. Encrypt your secret using

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
secret_name	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
201	Response when creating a secret	yes
204	Response when updating a secret	no

Delete a repository secret

DELETE /repos/{owner}/{repo}/agents/secrets/{secret_name}

Deletes a secret in a repository using the secret name.

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
secret_name	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
204	Response	no

List repository variables

GET /repos/{owner}/{repo}/agents/variables

Lists all repository variables.

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
per_page	query	no	The number of results per page (max 30). For more information, see "Using pagination in the REST API."
page	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes

Create a repository variable

POST /repos/{owner}/{repo}/agents/variables

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

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.

Responses

Status	Description	Has JSON body
201	Response	yes

Get a repository variable

GET /repos/{owner}/{repo}/agents/variables/{name}

Gets a specific variable in a repository.

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
name	path	yes	The name of the variable.

Responses

Status	Description	Has JSON body
200	Response	yes

Update a repository variable

PATCH /repos/{owner}/{repo}/agents/variables/{name}

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

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
name	path	yes	The name of the variable.

Responses

Status	Description	Has JSON body
204	Response	no

Delete a repository variable

DELETE /repos/{owner}/{repo}/agents/variables/{name}

Deletes a repository variable using the variable name.

Parameters

Name	In	Required	Description
owner	path	yes	The account owner of the repository. The name is not case sensitive.
repo	path	yes	The name of the repository without the .git extension. The name is not case sensitive.
name	path	yes	The name of the variable.

Responses

Status	Description	Has JSON body
204	Response	no