Create a pre-receive hook

POST/admin/pre-receive-hooks

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Body Params

required

application/jsonobject

allow_downstream_configuration boolean

optional

Whether enforcement can be overridden at the org or repo level. default: `false`

enforcement string

optional

The state of enforcement for this hook. default: `disabled`

environment object

required

The pre-receive environment where the script is executed.

name string

required

The name of the hook.

script string

required

The script that the hook runs.

script_repository object

required

The GitHub repository where the script is kept.

Responses

application/json pre-receive-hook object

Response

allow_downstream_configuration boolean

optional

enforcement string

optional

environment object

optional

created_at string

optional

default_environment boolean

optional

download object

optional

downloaded_at string

optionalnullable

message string

optionalnullable

state string

optional

url string

optional

hooks_count integer

optional

html_url string

optional

id integer

optional

image_url string

optional

name string

optional

url string

optional

id integer

optional

name string

optional

script string

optional

script_repository object

optional

full_name string

optional

html_url string

optional

id integer

optional

url string

optional

Response Example: 201 application/json

{
  "allow_downstream_configuration": false,
  "enforcement": "disabled",
  "environment": {
    "created_at": "2016-05-20T11:35:45-05:00",
    "default_environment": false,
    "download": {
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null,
      "state": "success",
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest"
    },
    "hooks_count": 1,
    "html_url": "https://github.example.com/admin/pre-receive-environments/2",
    "id": 2,
    "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
    "name": "DevTools Hook Env",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2"
  },
  "id": 1,
  "name": "Check Commits",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "full_name": "DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks",
    "id": 595,
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks"
  }
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

Request Sample: Shell / cURL

curl --request POST \
  --url {protocol}://{hostname}/api/v3/admin/pre-receive-hooks \
  --header 'content-type: application/json' \
  --data '{
  "allow_downstream_configuration": false,
  "enforcement": "disabled",
  "environment": {
    "id": 2
  },
  "name": "Check Commits",
  "script": "scripts/commit_check.sh",
  "script_repository": {
    "full_name": "DevIT/hooks"
  }
}'