Create a commit status

POST

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

Authorizations

• BasicAuth
• AuthorizationHeaderToken
• SudoParam
• SudoHeader
• TOTPHeader

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

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

object

context

string

description

string

state

CommitStatusState holds the state of a CommitStatus It can be “pending”, “success”, “error”, “failure”, “warning”, or “skipped”

string

target_url

string

Example ^generated

{
  "context": "example",
  "description": "example",
  "state": "example",
  "target_url": "example"
}

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

object

context

string

description

string

state

CommitStatusState holds the state of a CommitStatus It can be “pending”, “success”, “error”, “failure”, “warning”, or “skipped”

string

target_url

string

Responses

201

CommitStatus

Media type application/json

CommitStatus holds a single status of a single Commit

object

context

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

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 profile page

string

id

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

The user’s username

string

login_name

The user’s authentication sign-in name.

string

default: empty

prohibit_login

Is user login prohibited

boolean

pronouns

The user’s pronouns

string

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

string

website

The user’s website

string

description

string

id

integer format: int64

status

CommitStatusState holds the state of a CommitStatus It can be “pending”, “success”, “error”, “failure”, “warning”, or “skipped”

string

target_url

string

updated_at

string format: date-time

url

string

Example

{
  "creator": {
    "login_name": "empty"
  }
}

400

APIError is error format response

Media type application/json

APIError is an api error with a message

object

message

string

url

string

Example ^generated

{
  "message": "example",
  "url": "example"
}

404

APINotFound is a not found error response

Media type application/json

object

errors

Array<string>

message

string

url

string

Example ^generated

{
  "errors": [
    "example"
  ],
  "message": "example",
  "url": "example"
}