Generate a new api key for user

PUT 
/user/api-key

Generates a new api key for the user.

Cost: 0 credit per call.

Request

Header Parameters

X-Exorde-Api-Version stringrequired

Possible values: [v1]

The API version.

Responses

200

OK

application/json

Schema

Schema

apikey uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The generated api key for the user.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "apikey": "123e4567-e89b-12d3-a456-426655440000",
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

400

Bad Request

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

401

Unauthorized

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

403

Forbidden

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

429

Too Many Requests

application/json

Schema

Schema

error objectrequired

message stringrequired

The description of the error. It gives meaningful information about what happened.

code integerrequired

Possible values: >= 100 and <= 600

The error code. Please use our documentation to get more information about it.

userId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the user that made the request.

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

status objectrequired

cost int32required

Number of credits that were consumed for this request.

apiDeprecationNotice object

Deprecation notice of the API.

message stringrequired

A message that tells when the API version will be shut down.

shutdownDate date-timerequired

The date of removal of the API version, UTC date-time without timezone using RFC3339 format.

Example (from schema)

{
  "error": {
    "message": "An error occurred.",
    "code": 0,
    "userId": "123e4567-e89b-12d3-a456-426655440000",
    "requestId": "123e4567-e89b-12d3-a456-426655440000"
  },
  "status": {
    "cost": 0,
    "apiDeprecationNotice": {
      "message": "The version 1 of the API is deprecated and will be shut down the 2022-02-02 at 00:00:00 UTC.",
      "shutdownDate": "2022-02-02T00:00:00.000Z"
    }
  }
}

500

Internal Server Error

application/json

Schema

Schema

requestId uuid

Possible values: Value must match regular expression ^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$

The id of the request.

Example (from schema)

{
  "requestId": "123e4567-e89b-12d3-a456-426655440000"
}

503

Service Unavailable

Loading...