Create a commit status

POST

/repos/{owner}/{repo}/statuses/{sha}

const url = 'https://gitea.com/api/v1/repos/example/example/statuses/example';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"context":"example","description":"example","state":"pending","target_url":"https://example.com"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://gitea.com/api/v1/repos/example/example/statuses/example \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "context": "example", "description": "example", "state": "pending", "target_url": "https://example.com" }'

Authorizations

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

sha

required

string

Sha of the commit

Request Body

application/json

CreateStatusOption holds the information needed to create a new CommitStatus for a Commit

object

context

Context is the unique context identifier for the status

string

description

Description provides a brief description of the status

string

state

State represents the status state to set (pending, success, error, failure) pending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped is for when CommitStatus is Skipped

string

Allowed values: pending success error failure warning skipped

target_url

TargetURL is the URL to link to for more details

string format: uri

Responses

201

CommitStatus

application/json

CommitStatus holds a single status of a single Commit

object

context

Context is the unique context identifier for the status

string

created_at

string format: date-time

creator

User represents a user

object

active

Is user active

boolean

avatar_url

URL to the user’s avatar

string format: uri

created

string format: date-time

description

The user’s description

string

email

string format: email

followers_count

User counts

integer format: int64

following_count

integer format: int64

full_name

The user’s full name

string

html_url

URL to the user’s gitea page

string format: uri

The user’s id

integer format: int64

is_admin

Is the user an administrator

boolean

language

User locale

string

last_login

string format: date-time

location

The user’s location

string

login

string

login_name

Identifier of the user, provided by the external authenticator (if configured)

string

default: empty

prohibit_login

Is user login prohibited

boolean

restricted

Is user restricted

boolean

source_id

The ID of the user’s Authentication Source

integer format: int64

starred_repos_count

integer format: int64

visibility

User visibility level option: public, limited, private public UserVisibilityPublic limited UserVisibilityLimited private UserVisibilityPrivate

string

Allowed values: public limited private

website

The user’s website

string

description

Description provides a brief description of the status

string

ID is the unique identifier for the commit status

integer format: int64

status

State represents the status state (pending, success, error, failure) pending CommitStatusPending is for when the CommitStatus is Pending success CommitStatusSuccess is for when the CommitStatus is Success error CommitStatusError is for when the CommitStatus is Error failure CommitStatusFailure is for when the CommitStatus is Failure warning CommitStatusWarning is for when the CommitStatus is Warning skipped CommitStatusSkipped is for when CommitStatus is Skipped

string

Allowed values: pending success error failure warning skipped

target_url

TargetURL is the URL to link to for more details

string format: uri

updated_at

string format: date-time

url

URL is the API URL for this status

string format: uri

Example

{
  "creator": {
    "login_name": "empty",
    "visibility": "public"
  },
  "status": "pending"
}

400

APIError is error format response

Headers

message

string

url

string

404

APINotFound is a not found empty response