Sign in

v2

latestOpenAPI 3.1.02026-07-31131352.3 KB
Private endpoints
APIs

Update API

Updates an existing API by id. When no OAS document is supplied, only lifecycle fields can be changed.

put/apis/{id}

Request body

OR
OR
OR

Example request

{
  "oasUrl": "https://api.developer.overheid.nl/api-register/v1/openapi.json",
  "organisationUri": "https://developer.overheid.nl",
  "contact": {
    "email": "developer.overheid@geonovum.nl",
    "name": "Developer Overheid",
    "url": "https://developer.overheid.nl"
  },
  "sunset": "2027-11-11",
  "deprecated": "2025-10-10"
}

Response

OK

idstring required

The unique identifier for an API

titlestring required

The title of the API

summarystring nullable required

Short plain-text summary of the API. Derived from description when no explicit summary is available.

descriptionstring required

The description of the API

adrScorenumber nullable required

The ADR score of the API

Example response

{
  "id": "dicF0B3HR",
  "contact": {
    "email": "developer.overheid@geonovum.nl",
    "name": "Developer Overheid",
    "url": "https://developer.overheid.nl"
  },
  "title": "API register API v1",
  "summary": "Short summary of the API register.",
  "description": "This is version 1 of the API register. This description can also contain Markdown.",
  "organisation": {
    "uri": "https://developer.overheid.nl",
    "label": "developer.overheid.nl"
  },
  "adrScore": 85,
  "lifecycle": {
    "status": "deprecated",
    "version": "1.0.0",
    "deprecated": "2025-10-10",
    "sunset": "2027-11-11"
  }
}