NYnylas
Manage API keys

Create API key

Changed on
<div id="admonition-warning">⚠️ <b>Before you can use the Manage API Keys endpoints, you need to <a href="/docs/reference/api/manage-api-keys/">create a Nylas Service Account</a></b>.</div>

Creates an API key for the specified Nylas application.

post/v3/admin/applications/{application_id}/api-keys

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

namestring

A short, descriptive name for the API key.

expires_ininteger

How long the API key will be valid, in days. Accepts 1 to 9125. If you leave it out, the key is valid for 9125 days (25 years).

Example request

{
  "name": "example-key",
  "expires_in": 90
}

Response

OK

request_idstring

ID of the request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "data": {
    "api_key": "<NYLAS_API_KEY>",
    "application_id": "ad410018-d306-43f9-8361-fa5d7b2172e0",
    "created_at": 1742932766,
    "expires_at": 1753300766,
    "id": "<NYLAS_API_KEY_ID>",
    "name": "example-key",
    "permissions": [
      "all"
    ],
    "status": "active",
    "updated_at": 1742932766
  }
}

Changes

  • a669a04b02baRevision changes
    • breaking

      the request property type changed from number to integer

    • warning

      the request property's max was set to 9125.00

    • warning

      the request property's min was set to 1.00

  • 763d6b969cd7Revision changes
    • info

      added the optional property / to the response with the status