Update a pre-receive environment

You cannot modify the default environment. If you attempt to modify the default environment, you will receive a `422 Unprocessable Entity` response.

PATCH/admin/pre-receive-environments/{pre_receive_environment_id}

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

Request

Path Parameters

pre_receive_environment_id integer required

Body Params

optional

application/jsonobject

image_url string

optional

URL from which to download a tarball of this environment.

name string

optional

This pre-receive environment's new name.

Responses

application/json pre-receive-environment object

Response

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

Response Example: 200 application/json

{
  "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"
}

application/json object

Client Errors

errors array[object]

optional

items object

code string

optional

message string

optional

resource string

optional

message string

optional

Response Example: 422 application/json

{
  "errors": [
    {
      "code": "custom",
      "message": "Cannot modify or delete the default environment",
      "resource": "PreReceiveEnvironment"
    }
  ],
  "message": "Validation Failed"
}

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

pre_receive_environment_id *

Request Sample: Shell / cURL

curl --request PATCH \
  --url {protocol}://{hostname}/api/v3/admin/pre-receive-environments/{pre_receive_environment_id} \
  --header 'content-type: application/json' \
  --data '{
  "image_url": "string",
  "name": "string"
}'