Log in

POST

/api/v1/login/{env}

curl --request POST \
  --url https://osctrl.net/api/v1/login/example \
  --header 'Content-Type: application/json' \
  --data '{ "exp_hours": 1, "password": "example", "username": "example" }'

Authenticates an API user and returns a JWT token.

Parameters

Path Parameters

env

required

string

Environment name or UUID

Request Body^required

Request body

Media typeapplication/json

object

exp_hours

integer

password

string

username

string

Example^generated

{
  "exp_hours": 1,
  "password": "example",
  "username": "example"
}

Responses

200

OK

Media typeapplication/json

object

csrf_token

string

token

string

Example^generated

{
  "csrf_token": "example",
  "token": "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"
}