Get the current API key

GET 
/v2/me/apikey

Get information about the API key used for this request

Request

Header Parameters

User-Agent stringrequired
Custom User-Agent for your application, see user-agent.dev for implementation examples. Alternatively you can also use the 'MineSkin-User-Agent' header.
Example: ExampleApp/v1.0
Authorization string
API key from account.mineskin.org
Example: Bearer da84de82e960d6c0510088279878c79365ad5118d350d619f20324a5494f156b

Responses

200

API Key Info

application/json

Schema

Schema

key

object

required

API Key information

id string

API Key ID

Example: 21702ac21ab744d32b004fe0

name string

API Key name

Example: Test Key

user string

User ID

Example: ef4c52b01fea4715982d8e67fd93ef2d

createdAt string

Creation date

Example: 2022-11-01T18:06:58.634Z

allowedOrigins string[]

Allowed origins for this API key

allowedIps string[]

Allowed IPs for this API key

allowedAgents string[]

Allowed User-Agents for this API key

useCredits boolean

Whether this API key uses paid credits

Example: true

Example (from schema)

{
  "key": {
    "id": "21702ac21ab744d32b004fe0",
    "name": "Test Key",
    "user": "ef4c52b01fea4715982d8e67fd93ef2d",
    "createdAt": "2022-11-01T18:06:58.634Z",
    "allowedOrigins": [],
    "allowedIps": [
      "12.34.56.789"
    ],
    "allowedAgents": [
      "MineSkin-Test-App"
    ],
    "useCredits": true
  }
}

403

Forbidden

application/json

Schema

Schema

success booleanrequired
Example: false

errors

object[]

Array [

code string

message string

]

warnings

object[]

Array [

code string

message string

]

messages

object[]

Array [

code string

message string

]

links

object

Links to related resources

self string

Example (from schema)

{
  "success": false,
  "errors": [
    {
      "code": "generic_error",
      "message": "Something went wrong"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "messages": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": {
    "self": "string"
  }
}

404

Not Found

application/json

Schema

Schema

success booleanrequired
Example: false

errors

object[]

Array [

code string

message string

]

warnings

object[]

Array [

code string

message string

]

messages

object[]

Array [

code string

message string

]

links

object

Links to related resources

self string

Example (from schema)

{
  "success": false,
  "errors": [
    {
      "code": "generic_error",
      "message": "Something went wrong"
    }
  ],
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "messages": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "links": {
    "self": "string"
  }
}

Loading...