Skip to content
forgit api docs

Create external status check service

POST
/api/v4/projects/{id}/external_status_checks

Creates an external status check service for a specified project.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
One of:
string

The ID or URL-encoded path of the project

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
name
required

Display name of external status check

string
nullable
Example 
QA
shared_secret

HMAC shared secret

string
nullable
Example 
hmac-sha256
external_url
required

URL of external status check resource

string
nullable
Example 
https://www.example.com
protected_branch_ids

IDs of protected branches to scope the rule by

Array<integer>
nullable

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Created

Media type application/json
object
id
integer format: int64
name
string
project_id
integer format: int64
external_url
string
protected_branches
Array<object>
object
id
integer format: int64
name
string
push_access_levels
Array<object>
object
id
integer format: int64
access_level
integer
access_level_description
string
deploy_key_id
integer format: int64
user_id
integer format: int64
group_id
integer format: int64
member_role_id
integer format: int64
member_role_name
string
merge_access_levels
Array<object>
object
id
integer format: int64
access_level
integer
access_level_description
string
deploy_key_id
integer format: int64
user_id
integer format: int64
group_id
integer format: int64
member_role_id
integer format: int64
member_role_name
string
allow_force_push
boolean
unprotect_access_levels
Array<object>
object
id
integer format: int64
access_level
integer
access_level_description
string
deploy_key_id
integer format: int64
user_id
integer format: int64
group_id
integer format: int64
member_role_id
integer format: int64
member_role_name
string
code_owner_approval_required
boolean
inherited
boolean
hmac
boolean
Example 
{
  "id": 1,
  "name": "QA",
  "project_id": 1,
  "external_url": "https://www.example.com",
  "protected_branches": [
    {
      "id": 1,
      "name": "main",
      "push_access_levels": [
        {
          "id": 1,
          "access_level": 40,
          "access_level_description": "Maintainers",
          "deploy_key_id": 1,
          "user_id": 1,
          "group_id": 1,
          "member_role_id": 42,
          "member_role_name": "Lead Developer"
        }
      ],
      "merge_access_levels": [
        {
          "id": 1,
          "access_level": 40,
          "access_level_description": "Maintainers",
          "deploy_key_id": 1,
          "user_id": 1,
          "group_id": 1,
          "member_role_id": 42,
          "member_role_name": "Lead Developer"
        }
      ],
      "unprotect_access_levels": [
        {
          "id": 1,
          "access_level": 40,
          "access_level_description": "Maintainers",
          "deploy_key_id": 1,
          "user_id": 1,
          "group_id": 1,
          "member_role_id": 42,
          "member_role_name": "Lead Developer"
        }
      ]
    }
  ],
  "hmac": true
}

400

Section titled “ 400 ”

Bad Request

404

Section titled “ 404 ”

Not Found