List pre-receive environments

GET/admin/pre-receive-environments

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

Request

Query Parameters

per_page integer optional: Results per page (max 100)
page integer optional: Page number of the results to fetch.
direction string optional: One of `asc` (ascending) or `desc` (descending).
sort string optional

Responses

application/json array[pre-receive-environment object]

Response

items pre-receive-environment object

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": true,
    "download": {
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null,
      "state": "not_started",
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest"
    },
    "hooks_count": 14,
    "html_url": "https://github.example.com/admin/pre-receive-environments/1",
    "id": 1,
    "image_url": "githubenterprise://internal",
    "name": "Default",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1"
  },
  {
    "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"
  }
]

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

per_page

Results per page (max 100)

page

Page number of the results to fetch.

direction

One of `asc` (ascending) or `desc` (descending).

sort

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/admin/pre-receive-environments