Skip to main content
POST
/
api_keys
Create API key
curl --request POST \
  --url https://api.vidbeo.com/v2/api_keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Example",
  "type": "api",
  "permissions": []
}
'
{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "name": "Example key",
    "type": "api",
    "permissions": [],
    "value": "AbCdEgGhiJkLMnOpQrStUvWxYz",
    "created_by": "abcde12345abcde12345a",
    "created_time": "2024-01-01T00:00:00.000Z",
    "updated_by": "abcde12345abcde12345a",
    "updated_time": "2024-01-01T00:00:00.000Z"
  },
  "links": {},
  "errors": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
Required string length: 1 - 50
Example:

"Example"

​
type
enum<string>
Available options:
api
Example:

"api"

​
permissions
enum<string>[]

The actions this key is restricted to. Send an empty array for full read/write access or send ['fetch'] to limit to read-only

Available options:
fetch
Example:
[]

Response

API key (with value)

​
success
boolean
required
Example:

true

​
result
object
required
​
links
object
required
Example:
{}
​
errors
object[]
required
Example:
[]