RIPE NCC API

openapi: 3.1.0
info:
  title: RIPE NCC API
  version: '2026-10-28'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-28: 28 operation(s) read from 9 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; RIPE NCC has published no machine-readable contract that the
    pipeline could find. Engine: anthropic.'
  x-evidence-tiers:
    code-example: 10
    documentation: 18
    pages-with-code: 9
    pages-read: 9
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-28'
  x-generator: generate-contract-from-docs.py
  x-engine: anthropic
  x-sources:
  - https://docs.db.ripe.net/Update-Methods/RESTful-API
  - https://docs.db.ripe.net/Appendices/Appendix-K--API-Keys
  - https://docs.db.ripe.net/Appendices/Appendix-H--PGP-Authentication-Method
  - https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/RESTful-API-Queries
  - https://docs.db.ripe.net/Appendices/Appendix-I--Client-Certificate-Authentication
  - https://docs.db.ripe.net/Update-Methods/Syncupdates
  - https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/Registration-Data-Access-Protocol
  - https://docs.db.ripe.net/Installation-and-Development/Installation-instructions
  - https://docs.db.ripe.net/all-docs-combined
servers:
- url: https://rest.db.ripe.net
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.db.ripe.net/Appendices/Appendix-H--PGP-Authentication-Method
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl is used: curl -v --data-urlencode DATA@file.asc https://syncupdates.db.ripe.net . Whois will authenticate this signature
          using the public key in the key-cert object . Last updated: Pager Previous page Appendix G Object Types with Personal Data Next page
          Appendix I Client Certificate Authentication'
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://docs.db.ripe.net/Update-Methods/Syncupdates
      parameters:
      - name: HELP
        in: query
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -v https://syncupdates-test.db.ripe.net/?HELP=yes\n Example of a POST update request: curl -v -4 -X POST -H \"Content-Type:\
          \ multipart/form-data; boundary=--------------------------466af99a9520\" --data-binary @form.txt https://syncupdates-test.db.ripe.net\n\
          ----------------------------466af99a9520\nContent-Disposition: form-data; name=\"DATA\"\norganisation: ORG-TS1-TEST\norg-name: RIPE\
          \ NCC Training Se"
    put:
      operationId: put
      tags:
      - Api
      summary: PUT /
      x-source: https://docs.db.ripe.net/all-docs-combined
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl http://<host>:<port>/whois/_count\n ✔ Expected output: Number of indexed documents Perform a Full-Text Search Query curl\
          \ \"http://localhost:1080/whois/fulltextsearch/select.json?q=Example&wt=json\"\n ✔ Expected output: JSON results containing Whois records\
          \ matching \"Example\" Support Overview Support Overview ​ User Manuals ​ RIPE Database Document Library Manuals and reference material\
          \ for new an"
  /abuse-contact/{resource}:
    get:
      operationId: get_abuse_contact_resource
      tags:
      - Abuse Contact
      summary: Lookup abuse contact email for an internet resource (IPv4 address, range or prefix, IPv6 address or prefix, AS number).
      x-source: https://docs.db.ripe.net/all-docs-combined
      parameters:
      - name: resource
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAbuseContactResourceResponse'
      x-evidence:
        kind: documentation
  /domain/193.0.6.139.in-addr.arpa:
    get:
      operationId: get_domain_193_0_6_139_in_addr_arpa
      tags:
      - Domain
      summary: Query DOMAIN objects for domain names.
      x-source: https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/Registration-Data-Access-Protocol
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDomain19306139InAddrArpaResponse'
      x-evidence:
        kind: documentation
  /geolocation:
    get:
      operationId: get_geolocation
      tags:
      - Geolocation
      summary: Returns geolocation information for the specified address.
      x-source: https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/RESTful-API-Queries
      parameters:
      - name: ipkey
        in: query
        required: true
        schema:
          type: string
        description: IPv4 or IPv6 address.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetGeolocationResponse'
      x-evidence:
        kind: documentation
  /ip/2001:67c:2e8:9:{c100}:14e6:
    get:
      operationId: get_ip_2001_67c_2e8_9_c100_14e6
      tags:
      - Ip
      summary: GET /ip/2001:67c:2e8:9::c100:14e6
      x-source: https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/Registration-Data-Access-Protocol
      parameters:
      - name: c100
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -v https://rdap.db.ripe.net/ip/2001:67c:2e8:9::c100:14e6 and an example query for domain information: curl -v https://rdap.db.ripe.net/domain/193.0.6.139.in-addr.arpa
          If the RIPE Database is not authoritative for the requested resource, the response will redirect to the authoritative RIR with a HTTP
          301 response status. Entity Search ​ The entities path segment allows searching for matching e'
  /metadata/templates/person.xml:
    get:
      operationId: get_metadata_templates_person_xml
      tags:
      - Metadata
      summary: Returns the RPSL template for given object type.
      x-source: https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/RESTful-API-Queries
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMetadataTemplatesPersonXmlResponse'
      x-evidence:
        kind: documentation
  /pez/person/PP1-RIPE:
    get:
      operationId: get_pez_person_PP1_RIPE
      tags:
      - Pez
      summary: Returns an object from the RIPE Database.
      x-source: https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/RESTful-API-Queries
      parameters:
      - name: unfiltered
        in: query
        required: false
        schema:
          type: string
        description: The returned object should not be filtered.
      - name: unformatted
        in: query
        required: false
        schema:
          type: string
        description: Return the resource in its original formatting.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPezPersonPp1RipeResponse'
      x-evidence:
        kind: documentation
  /ripe/inetnum/193.0.0.0%20-%20193.0.7.255:
    get:
      operationId: get_ripe_inetnum_193_0_0_0_20_20193_0_7_255
      tags:
      - Ripe
      summary: GET /ripe/inetnum/193.0.0.0%20-%20193.0.7.255
      x-source: https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/RESTful-API-Queries
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl ''https://rest.db.ripe.net/ripe/inetnum/193.0.0.0%20-%20193.0.7.255?unfiltered'' Any spaces in the command must be encoded.
          The response will be returned by default in XML format. Alternatively JSON or text/plain can be returned: curl -H ''Accept: application/json''
          Additional resources: Version list Version lookup Method: GET ​ URI Format: /{source}/{objectType}/{key} ​ Path Parameters ​ name de'
  /ripe/inetnum/193.0.0.0%20-%20193.0.7.255.json:
    get:
      operationId: get_ripe_inetnum_193_0_0_0_20_20193_0_7_255_json
      tags:
      - Ripe
      summary: Returns an object from the RIPE Database.
      x-source: https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/RESTful-API-Queries
      parameters:
      - name: unfiltered
        in: query
        required: false
        schema:
          type: string
        description: The returned object should not be filtered.
      - name: unformatted
        in: query
        required: false
        schema:
          type: string
        description: Return the resource in its original formatting.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRipeInetnum193000202019307255JsonResponse'
      x-evidence:
        kind: documentation
  /ripe/mntner/PP1-RIPE:
    get:
      operationId: get_ripe_mntner_PP1_RIPE
      tags:
      - Ripe
      summary: Retrieve a specific maintainer object from the RIPE Database.
      x-source: https://docs.db.ripe.net/all-docs-combined
      parameters:
      - name: unfiltered
        in: query
        required: false
        schema:
          type: boolean
        description: The returned object should not be filtered.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRipeMntnerPp1RipeResponse'
      x-evidence:
        kind: documentation
  /ripe/mntner/RIPE-DBM-MNT:
    get:
      operationId: get_ripe_mntner_RIPE_DBM_MNT
      tags:
      - Ripe
      summary: Returns an object from the RIPE Database.
      x-source: https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/RESTful-API-Queries
      parameters:
      - name: unfiltered
        in: query
        required: false
        schema:
          type: string
        description: The returned object should not be filtered.
      - name: unformatted
        in: query
        required: false
        schema:
          type: string
        description: Return the resource in its original formatting.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRipeMntnerRipeDbmMntResponse'
      x-evidence:
        kind: documentation
  /ripe/person:
    get:
      operationId: get_ripe_person
      tags:
      - Ripe
      summary: Search for person objects in the RIPE Database.
      x-source: https://docs.db.ripe.net/all-docs-combined
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRipePersonResponse'
      x-evidence:
        kind: documentation
  /ripe/person/PP1-RIPE:
    get:
      operationId: get_ripe_person_PP1_RIPE
      tags:
      - Ripe
      summary: Retrieve a specific person object from the RIPE Database.
      x-source: https://docs.db.ripe.net/all-docs-combined
      parameters:
      - name: unfiltered
        in: query
        required: false
        schema:
          type: boolean
        description: The returned object should not be filtered.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRipePersonPp1RipeResponse'
      x-evidence:
        kind: documentation
  /ripe/person/TP1-RIPE:
    get:
      operationId: get_ripe_person_TP1_RIPE
      tags:
      - Ripe
      summary: Retrieve a specific person object from the RIPE Database.
      x-source: https://docs.db.ripe.net/all-docs-combined
      parameters:
      - name: unfiltered
        in: query
        required: false
        schema:
          type: boolean
        description: The returned object should not be filtered.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRipePersonTp1RipeResponse'
      x-evidence:
        kind: documentation
  /ripe/person/pp1-ripe:
    get:
      operationId: get_ripe_person_pp1_ripe
      tags:
      - Ripe
      summary: Retrieve a specific person object from the RIPE Database.
      x-source: https://docs.db.ripe.net/all-docs-combined
      parameters:
      - name: unfiltered
        in: query
        required: false
        schema:
          type: boolean
        description: The returned object should not be filtered.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRipePersonPp1RipeResponse2'
      x-evidence:
        kind: documentation
  /ripe/person/{personid}:
    get:
      operationId: get_ripe_person_personid
      tags:
      - Ripe
      summary: Query for an unfiltered person object.
      x-source: https://docs.db.ripe.net/Appendices/Appendix-K--API-Keys
      parameters:
      - name: personid
        in: path
        required: true
        schema:
          type: string
      - name: unfiltered
        in: query
        required: false
        schema:
          type: boolean
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRipePersonPersonidResponse'
      x-evidence:
        kind: documentation
        collapsed_from: 2 example path(s) differing only at personId
  /test/person:
    get:
      operationId: get_test_person
      tags:
      - Test
      summary: Search for person objects in the TEST Database.
      x-source: https://docs.db.ripe.net/all-docs-combined
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTestPersonResponse'
      x-evidence:
        kind: documentation
  /test/person/AA1-TEST:
    get:
      operationId: get_test_person_AA1_TEST
      tags:
      - Test
      summary: Returns an object from the RIPE Database.
      x-source: https://docs.db.ripe.net/How-to-Query-the-RIPE-Database/RESTful-API-Queries
      parameters:
      - name: unfiltered
        in: query
        required: false
        schema:
          type: string
        description: The returned object should not be filtered.
      - name: unformatted
        in: query
        required: false
        schema:
          type: string
        description: Return the resource in its original formatting.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTestPersonAa1TestResponse'
      x-evidence:
        kind: documentation
  /whois/_count:
    get:
      operationId: get_whois_count
      tags:
      - Whois
      summary: Confirm that Elasticsearch is properly indexing data by returning the number of indexed documents.
      x-source: https://docs.db.ripe.net/Installation-and-Development/Installation-instructions
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /whois/fulltextsearch/select.json:
    get:
      operationId: get_whois_fulltextsearch_select_json
      tags:
      - Whois
      summary: Perform a Full-Text Search Query to retrieve JSON results containing Whois records.
      x-source: https://docs.db.ripe.net/Installation-and-Development/Installation-instructions
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
        description: Search query string
      - name: wt
        in: query
        required: false
        schema:
          type: string
        description: Response format (e.g., json)
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /whois/test/inetnum/10.11.11.0/{1011110Id}:
    get:
      operationId: get_whois_test_inetnum_10_11_11_0_1011110Id
      tags:
      - Whois
      summary: GET /whois/test/inetnum/10.11.11.0/{1011110Id}
      x-source: https://docs.db.ripe.net/Installation-and-Development/Installation-instructions
      parameters:
      - name: 1011110Id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl: curl http://localhost:1080/whois/test/inetnum/10.11.11.0/24\n You can check the instructions in WHOIS-REST-API for more\
          \ info about the REST API How to allow unlimited queries ​ The Whois server can block a client's IP as explained here . You can allow\
          \ unlimited queries from a certain IP by running a few queries as follows. The database ACL_LOCAL contains tables related to access\
          \ control logic"
  /{source}/{objecttype}:
    post:
      operationId: post_source_objecttype
      tags:
      - Api
      summary: Create an object in the RIPE database.
      x-source: https://docs.db.ripe.net/Update-Methods/RESTful-API
      parameters:
      - name: source
        in: path
        required: true
        schema:
          type: string
      - name: objecttype
        in: path
        required: true
        schema:
          type: string
      - name: unformatted
        in: query
        required: false
        schema:
          type: string
        description: Keep the formatting of the resource as provided in the request (spaces, end-of-lines)
      - name: dry-run
        in: query
        required: false
        schema:
          type: string
        description: Optional. Perform validation but don't perform the update.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSourceObjecttypeRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostSourceObjecttypeResponse'
      x-evidence:
        kind: documentation
  /{source}/{objecttype}/{key}:
    delete:
      operationId: delete_source_objecttype_key
      tags:
      - Api
      summary: Deletes an object from the Database.
      x-source: https://docs.db.ripe.net/Update-Methods/RESTful-API
      parameters:
      - name: source
        in: path
        required: true
        schema:
          type: string
      - name: objecttype
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: reason
        in: query
        required: false
        schema:
          type: string
        description: Reason for deleting given object. Optional.
      - name: dry-run
        in: query
        required: false
        schema:
          type: string
        description: Optional. Perform validation but don't delete the object.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteSourceObjecttypeKeyResponse'
      x-evidence:
        kind: documentation
    put:
      operationId: put_source_objecttype_key
      tags:
      - Api
      summary: Updates an existing object in the RIPE Database.
      x-source: https://docs.db.ripe.net/Update-Methods/RESTful-API
      parameters:
      - name: source
        in: path
        required: true
        schema:
          type: string
      - name: objecttype
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: unformatted
        in: query
        required: false
        schema:
          type: string
        description: Keep the formatting of the resource as provided in the request (spaces, end-of-lines)
      - name: dry-run
        in: query
        required: false
        schema:
          type: string
        description: Optional. Perform validation but don't perform the update.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutSourceObjecttypeKeyRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutSourceObjecttypeKeyResponse'
      x-evidence:
        kind: documentation
  /{source}/{objecttype}/{key}/versions:
    get:
      operationId: get_source_objecttype_key_versions
      tags:
      - Versions
      summary: Lists all versions of RIPE Database object, including the date and operation for each version.
      x-source: https://docs.db.ripe.net/all-docs-combined
      parameters:
      - name: source
        in: path
        required: true
        schema:
          type: string
      - name: objecttype
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceObjecttypeKeyVersionsResponse'
      x-evidence:
        kind: documentation
  /{source}/{objecttype}/{key}/versions/{versionnumber}:
    get:
      operationId: get_source_objecttype_key_versions_versionnumber
      tags:
      - Versions
      summary: Show a specific version of a RIPE Database object.
      x-source: https://docs.db.ripe.net/all-docs-combined
      parameters:
      - name: source
        in: path
        required: true
        schema:
          type: string
      - name: objecttype
        in: path
        required: true
        schema:
          type: string
      - name: key
        in: path
        required: true
        schema:
          type: string
      - name: versionnumber
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetSourceObjecttypeKeyVersionsVersionnumberResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetAbuseContactResourceResponse:
      type: object
      properties:
        AbuseResources:
          type: object
          description: An AbuseResources containing locator URIs to matching objects
    GetDomain19306139InAddrArpaResponse:
      type: object
      properties:
        RDAP object:
          type: object
          description: RDAP formatted response containing domain information
    GetGeolocationResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing locator URIs to matching objects.
    GetMetadataTemplatesPersonXmlResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the template of the specified type.
    GetPezPersonPp1RipeResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the object.
    GetRipeInetnum193000202019307255JsonResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the object.
    GetRipeMntnerPp1RipeResponse:
      type: object
      properties:
        objects:
          type: array
    GetRipeMntnerRipeDbmMntResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the object.
    GetRipePersonResponse:
      type: object
      properties:
        objects:
          type: array
    GetRipePersonPp1RipeResponse:
      type: object
      properties:
        objects:
          type: array
    GetRipePersonTp1RipeResponse:
      type: object
      properties:
        objects:
          type: array
    GetRipePersonPp1RipeResponse2:
      type: object
      properties:
        objects:
          type: array
    GetRipePersonPersonidResponse:
      type: object
      properties:
        person object:
          type: object
    GetTestPersonResponse:
      type: object
      properties:
        objects:
          type: array
    GetTestPersonAa1TestResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the object.
    PostSourceObjecttypeRequest:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the object to be created
      required:
      - WhoisResource
    PostSourceObjecttypeResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the newly created, unfiltered object
    DeleteSourceObjecttypeKeyResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the (filtered) deleted object
    PutSourceObjecttypeKeyRequest:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the new version of the specified objects
      required:
      - WhoisResource
    PutSourceObjecttypeKeyResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing either the newly created, unfiltered object or the error message in case of a bad/unauthorized
            request
    GetSourceObjecttypeKeyVersionsResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing information about updates for the requested object or the error message
    GetSourceObjecttypeKeyVersionsVersionnumberResponse:
      type: object
      properties:
        WhoisResource:
          type: object
          description: A WhoisResource containing the requested version of the object or the error message
  securitySchemes:
    basic:
      type: http
      scheme: basic
security:
- basic: []
tags:
- name: Abuse Contact
- name: Api
- name: Domain
- name: Geolocation
- name: Ip
- name: Metadata
- name: Pez
- name: Ripe
- name: Test
- name: Versions
- name: Whois