Use the REST API to interact with tag objects in your Git database on GitHub.
A Git tag is similar to a Git reference, but the Git commit that it points to never changes. Git tags are helpful when you want to point to specific releases. These endpoints allow you to read and write tag objects to your Git database on GitHub. The API only supports annotated tag objects, not lightweight tags.
Create a tag objectNote that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary.
Signature verification object
The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
verified boolean Indicates whether GitHub considers the signature in this commit to be verified. reason string The reason for verified value. Possible values and their meanings are enumerated in table below. signature string The signature that was extracted from the commit. payload string The value that was signed. verified_at string The date the signature was verified by GitHub.
These are the possible values for reason in the verification object:
expired_key The key that made the signature is expired. not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature. gpgverify_error There was an error communicating with the signature verification service. gpgverify_unavailable The signature verification service is currently unavailable. unsigned The object does not include a signature. unknown_signature_type A non-PGP signature was found in the commit. no_user No user was associated with the committer email address in the commit. unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on their account. bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature. unknown_key The key that made the signature has not been registered with any user's account. malformed_signature There was an error parsing the signature. invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature. valid None of the above errors applied, so the signature is considered to be verified. Fine-grained access tokens for "Create a tag object"
This endpoint works with the following fine-grained token types:
The fine-grained token must have the following permission set:
accept string
Setting to application/vnd.github+json is recommended.
owner string Required
The account owner of the repository. The name is not case sensitive.
repo string Required
The name of the repository without the .git extension. The name is not case sensitive.
tag string Required
The tag's name. This is typically a version (e.g., "v0.0.1").
message string Required
The tag message.
object string Required
The SHA of the git object this is tagging.
type string Required
The type of the object we're tagging. Normally this is a commit but it can also be a tree or a blob.
Can be one of: commit, tree, blob
tagger object
An object with information about the individual creating the tag.
Properties oftagger Name, Type, Description
name string Required
The name of the author of the tag
email string Required
The email of the author of the tag
date string
When this object was tagged. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
201
Created
409
Conflict
422
Validation failed, or the endpoint has been spammed.
Code samples for "Create a tag object" Request examplepost/repos/{owner}/{repo}/git/tags
Copy to clipboard curl request example
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/git/tags \ -d '{"tag":"v0.0.1","message":"initial version","object":"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c","type":"commit","tagger":{"name":"Monalisa Octocat","email":"octocat@github.com","date":"2011-06-17T14:53:35-07:00"}}'
Response
Status: 201
{ "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", "message": "initial version", "tagger": { "name": "Monalisa Octocat", "email": "octocat@github.com", "date": "2014-11-07T22:01:45Z" }, "object": { "type": "commit", "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" }, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null, "verified_at": null } }
Signature verification object
The response will include a verification object that describes the result of verifying the commit's signature. The following fields are included in the verification object:
verified boolean Indicates whether GitHub considers the signature in this commit to be verified. reason string The reason for verified value. Possible values and their meanings are enumerated in table below. signature string The signature that was extracted from the commit. payload string The value that was signed. verified_at string The date the signature was verified by GitHub.
These are the possible values for reason in the verification object:
expired_key The key that made the signature is expired. not_signing_key The "signing" flag is not among the usage flags in the GPG key that made the signature. gpgverify_error There was an error communicating with the signature verification service. gpgverify_unavailable The signature verification service is currently unavailable. unsigned The object does not include a signature. unknown_signature_type A non-PGP signature was found in the commit. no_user No user was associated with the committer email address in the commit. unverified_email The committer email address in the commit was associated with a user, but the email address is not verified on their account. bad_email The committer email address in the commit is not included in the identities of the PGP key that made the signature. unknown_key The key that made the signature has not been registered with any user's account. malformed_signature There was an error parsing the signature. invalid The signature could not be cryptographically verified using the key whose key-id was found in the signature. valid None of the above errors applied, so the signature is considered to be verified. Fine-grained access tokens for "Get a tag"
This endpoint works with the following fine-grained token types:
The fine-grained token must have the following permission set:
This endpoint can be used without authentication or the aforementioned permissions if only public resources are requested.
Parameters for "Get a tag" Headers Name, Type, Descriptionaccept string
Setting to application/vnd.github+json is recommended.
owner string Required
The account owner of the repository. The name is not case sensitive.
repo string Required
The name of the repository without the .git extension. The name is not case sensitive.
tag_sha string Required
200
OK
404
Resource not found
409
Conflict
Code samples for "Get a tag" Request exampleget/repos/{owner}/{repo}/git/tags/{tag_sha}
Copy to clipboard curl request example
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/git/tags/TAG_SHA
Response
Status: 200
{ "node_id": "MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==", "tag": "v0.0.1", "sha": "940bd336248efae0f9ee5bc7b2d5c985887b16ac", "url": "https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac", "message": "initial version", "tagger": { "name": "Monalisa Octocat", "email": "octocat@github.com", "date": "2014-11-07T22:01:45Z" }, "object": { "type": "commit", "sha": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c", "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c" }, "verification": { "verified": false, "reason": "unsigned", "signature": null, "payload": null, "verified_at": null } }
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4