VTEX · Schema

CreatenewappkeyResponse

Response body of sucessful call to /api/vlm/appkeys.

CommerceE-CommerceRetailMarketplacePayments

Properties

Name Type Description
id string ID of the application key.
appKey string AppKey.
appToken string AppToken. For security reasons, it should always be null.
label string Label of the application key.
createdIn string Creation date of the application key.
isActive boolean Defines if the application key is active (`true`) or not (`false`).
View JSON Schema on GitHub

JSON Schema

vtex-createnewappkeyresponse-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreatenewappkeyResponse",
  "title": "CreatenewappkeyResponse",
  "description": "Response body of sucessful call to /api/vlm/appkeys.",
  "required": [
    "id",
    "appKey",
    "appToken",
    "label",
    "createdIn",
    "isActive"
  ],
  "type": "object",
  "properties": {
    "id": {
      "description": "ID of the application key.",
      "type": "string"
    },
    "appKey": {
      "description": "AppKey.",
      "type": "string"
    },
    "appToken": {
      "description": "AppToken. For security reasons, it should always be null.",
      "type": "string",
      "nullable": true
    },
    "label": {
      "description": "Label of the application key.",
      "type": "string"
    },
    "createdIn": {
      "description": "Creation date of the application key.",
      "type": "string",
      "format": "date-time"
    },
    "isActive": {
      "description": "Defines if the application key is active (`true`) or not (`false`).",
      "type": "boolean"
    }
  }
}