Skip to main content
Die REST-API verfügt jetzt über eine Versionskontrolle. Weitere Informationen findest du unter Informationen zur API-Versionsverwaltung.

REST-API-Endpunkte für Repository-Tags

Verwende die REST-API zum Verwalten von Tags für ein Repository.

List tag protection states for a repository

This returns the tag protection states of a repository.

This information is only available to repository administrators.

Differenzierte Zugriffstoken für "List tag protection states for a repository"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

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

  • administration:read

Parameter für „List tag protection states for a repository“

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.

HTTP-Antwortstatuscodes für „List tag protection states for a repository“

StatuscodeBESCHREIBUNG
200

OK

403

Forbidden

404

Resource not found

Codebeispiele für „List tag protection states for a repository“

Beispiel für eine Anfrage

get/repos/{owner}/{repo}/tags/protection
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/tags/protection

Response

Status: 200
[ { "id": 2, "pattern": "v1.*" } ]

Create a tag protection state for a repository

This creates a tag protection state for a repository. This endpoint is only available to repository administrators.

Differenzierte Zugriffstoken für "Create a tag protection state for a repository"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

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

  • administration:write

Parameter für „Create a tag protection state for a repository“

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
pattern string Erforderlich

An optional glob pattern to match against when enforcing tag protection.

HTTP-Antwortstatuscodes für „Create a tag protection state for a repository“

StatuscodeBESCHREIBUNG
201

Created

403

Forbidden

404

Resource not found

Codebeispiele für „Create a tag protection state for a repository“

Beispiel für eine Anfrage

post/repos/{owner}/{repo}/tags/protection
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/tags/protection \ -d '{"pattern":"v1.*"}'

Response

Status: 201
{ "enabled": true }

Delete a tag protection state for a repository

This deletes a tag protection state for a repository. This endpoint is only available to repository administrators.

Differenzierte Zugriffstoken für "Delete a tag protection state for a repository"

Dieser Endpunkt funktioniert mit den folgenden Tokentypen.:

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

  • administration:write

Parameter für „Delete a tag protection state for a repository“

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.

tag_protection_id integer Erforderlich

The unique identifier of the tag protection.

HTTP-Antwortstatuscodes für „Delete a tag protection state for a repository“

StatuscodeBESCHREIBUNG
204

No Content

403

Forbidden

404

Resource not found

Codebeispiele für „Delete a tag protection state for a repository“

Beispiel für eine Anfrage

delete/repos/{owner}/{repo}/tags/protection/{tag_protection_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/repos/OWNER/REPO/tags/protection/TAG_PROTECTION_ID

Response

Status: 204