Get environment

GET

/api/v1/environments/{env}

curl --request GET \
  --url https://osctrl.net/api/v1/environments/example \
  --header 'Authorization: <Authorization>'

Returns one environment by name or UUID.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

env

required

string

Environment name or UUID

Responses

200

OK

Media typeapplication/json

object

accept_enrolls

boolean

carves_tls

boolean

config_interval

integer

config_tls

boolean

created_at

string

debug_http

boolean

enroll_expire

string

hostname

string

icon

string

id

integer

log_interval

integer

logging_tls

boolean

name

string

query_interval

integer

query_tls

boolean

remove_expire

string

type

string

updated_at

string

uuid

string

Example^generated

{
  "accept_enrolls": true,
  "carves_tls": true,
  "config_interval": 1,
  "config_tls": true,
  "created_at": "example",
  "debug_http": true,
  "enroll_expire": "example",
  "hostname": "example",
  "icon": "example",
  "id": 1,
  "log_interval": 1,
  "logging_tls": true,
  "name": "example",
  "query_interval": 1,
  "query_tls": true,
  "remove_expire": "example",
  "type": "example",
  "updated_at": "example",
  "uuid": "example"
}

400

Bad request

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

401

Unauthorized

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

403

Forbidden

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

404

Not found

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

409

Conflict

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

429

Too many requests

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

500

Internal server error

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}

503

Service unavailable

Media typeapplication/json

object

code

string

error

string

Example^generated

{
  "code": "example",
  "error": "example"
}