API

HTTP-API voor projecten, apps en de rest van het platform.

Elke resource die je in het dashboard ziet, heeft een HTTP-endpoint. Roep dat aan vanuit de CLI, CI, scripts of een andere client die JSON kan versturen.

• Basis-URL: https://api.nodion.com
• Interactieve documentatie: api.nodion.com/v2/docs
• OpenAPI: api.nodion.com/v2/openapi.yaml

Authenticatie

Stuur bij elk request een bearer-token mee:

httpAuthorization: Bearer nodion_…

Er zijn twee soorten tokens:

• Persoonlijke API-sleutels (nodion_…) handelen namens jou. Je kiest de scopes en kunt de sleutel beperken tot bepaalde projecten. Maak ze aan onder Account → Security. Het token wordt slechts één keer getoond.
• Projectsleutels (nodion_proj_…) horen bij één project, niet bij een persoon, zodat CI blijft werken als iemand vertrekt. Maak ze aan op het tabblad API keys van het project.

Scopes van een persoonlijke sleutel:

• read: resources weergeven en ophalen
• write: aanmaken, bijwerken en verwijderen
• deploy: deployments starten
• env:read / env:write: waarden van omgevingsvariabelen
• logs:read: applicatielogs

Leesacties hebben read nodig, schrijfacties write, tenzij een operatie om een beperktere scope vraagt (bijvoorbeeld deploy). Projectsleutels hebben geen scopes. Ze kunnen alles binnen dat project. Facturatie en 2FA blijven in het dashboard; API-sleutels geven daar geen toegang toe.

Een project kiezen

Geneste routes zien eruit als /v2/projects/{id}/…. Werk je in één project, gebruik dan het korte pad en stuur het project-ID mee als header:

httpX-Nodion-Project: prj_…

Eerste request

bashcurl https://api.nodion.com/v2/applications \
  -H "Authorization: Bearer $NODION_TOKEN" \
  -H "X-Nodion-Project: $NODION_PROJECT"

Een deploy starten (vereist de scope deploy op een persoonlijke sleutel):

bashcurl -X POST https://api.nodion.com/v2/applications/$APP_ID/deployments \
  -H "Authorization: Bearer $NODION_TOKEN"

Lijsten, fouten en limieten

Antwoorden met een collectie zien eruit als { "data": [ … ], "next_cursor": null }. Geef ?limit= en de vorige next_cursor als ?cursor= mee om te pagineren.

Fouten volgen RFC 9457 (application/problem+json) met een stabiele code en een request_id. Geef die ID door als je contact opneemt met support. De openbare catalogus staat op GET /v2/errors.

Voor API-aanroepen met een sleutel geldt een rate limit per account. Responses bevatten RateLimit-Limit, RateLimit-Remaining en RateLimit-Reset. Een 429 stuurt ook Retry-After mee. Elke response heeft X-Request-Id.

In de interactieve documentatie vind je de body van elk request en een console om calls uit te proberen. De pagina's hieronder tonen dezelfde endpoints in de stijl van deze site.

Endpoints

Gegenereerd uit het openbare OpenAPI-document. 278 operaties, gegroepeerd zoals in de specificatie.