Execute enrollment action

POST

/api/v1/environments/{env}/enroll/{action}

curl --request POST \
  --url https://osctrl.net/api/v1/environments/example/enroll/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "certificate": "example", "url_deb_pkg": "example", "url_mac_pkg": "example", "url_msi_pkg": "example", "url_rpm_pkg": "example" }'

Extends, expires, rotates, or updates enrollment values for an environment.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

env

required

string

Environment name or UUID

action

required

string

Enrollment action

Request Body^required

Request body

Media typeapplication/json

object

certificate

string

url_deb_pkg

string

url_mac_pkg

string

url_msi_pkg

string

url_rpm_pkg

string

Example^generated

{
  "certificate": "example",
  "url_deb_pkg": "example",
  "url_mac_pkg": "example",
  "url_msi_pkg": "example",
  "url_rpm_pkg": "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"
}