repos.tags.create

Create a lightweight tag pointing to a specific commit. Annotated tags are not created through this endpoint.

Scope: git:write on the repository.

POST /api/repos/{repo_name}/tags

TypeScript

TypeScript

import { Pierre } from '@pierre/sdk';

// The client reads PIERRE_ORG and PIERRE_PRIVATE_KEY.
const pierre = new Pierre();

const tag = await pierre.repos.tags.create({
  repo_name: 'my-demo-repository',
  name: 'v1.0.0',
  ref: 'main',
});
console.log(tag);

200

{
  "message": "tag created",
  "name": "v1.0.0",
  "sha": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"
}

Authorizations

Authorization · string · header · required

JWT bearer token signed with your organization's registered signing key. There is no OAuth authorization server; you mint tokens yourself and the token's scopes claim carries the granted permission scopes. Public scopes: git:read (read repository contents), git:write (write branches, commits, tags, and notes), repo:write (create and manage repositories), org:read (list an organization's repositories). Each operation's security requirement names the scopes it requires. See https://code.storage/docs/getting-started/authentication for how to mint tokens.

Path Parameters

repo_name · string · required

The repository name, for example acme/web.

Body

application/json

Create a lightweight tag that points to an exact commit SHA.

Create-tag request body describing the new tag and the commit it points to.

name · string · required

Tag name. Must be a valid Git ref name and must not start with refs/.

Example:

"v1.0.0"

ref · string

Branch, tag, or commit the tag should point to. Provide ref or the deprecated target.

Example:

"main"

target · string · deprecated

Deprecated: use ref. Commit the tag should point to.

Example:

"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"

Response

200

application/json

Tag creation result.

Result of creating a tag.

message · string · required

Human-readable result message.

Example:

"tag created"

name · string · required

Tag name.

Example:

"v1.0.0"

sha · string · required

Commit SHA the tag points to.

Example:

"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"