Execute environment action

POST

/api/v1/environments/actions

curl --request POST \
  --url https://osctrl.net/api/v1/environments/actions \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "example", "hostname": "example", "icon": "example", "name": "example", "type": "example", "uuid": "example" }'

Creates or modifies an environment using the legacy action endpoint.

Authorizations

• ApiKeyAuth

Request Body^required

Request body

Media typeapplication/json

object

action

string

hostname

string

icon

string

name

string

type

string

uuid

string

Example^generated

{
  "action": "example",
  "hostname": "example",
  "icon": "example",
  "name": "example",
  "type": "example",
  "uuid": "example"
}

Responses

200

OK

Media typeapplication/json

object

message

string

Example^generated

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