X-Road (NIIS) Configuration Source Anchors API

resources related to Configuration Source Anchors

GitHub OpenAPI

Operations 3

GET /configuration-sources/{configuration_type}/anchor CS administrator views the anchor of a configuration source #
GET /configuration-sources/{configuration_type}/anchor/download download configuration anchor information #
PUT /configuration-sources/{configuration_type}/anchor/re-create re-create the configuration source anchor file #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/x-road-global:x-road-global-configuration-source-anchors-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

x-road-global-configuration-source-anchors-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: X Road Global Configuration Source Anchors API
  version: 1.0.0
  contact:
    email: info@niis.org
    name: Nordic Institute for Interoperability Solutions (NIIS)
    url: https://github.com/nordic-institute/X-Road-development/#enhancement-requests-and-error-reports
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  description: 'Operations tagged configuration-source-anchors across 2 of this provider''s published API definitions: central-server-admin-openapi.yaml, x-road-global-central-server-admin-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: basepath for API v1
  url: /api/v1
security:
- ApiKeyAuth: []
tags:
- name: configuration-source-anchors
  description: resources related to Configuration Source Anchors
paths:
  /configuration-sources/{configuration_type}/anchor:
    get:
      description: Administrator views the anchor of a specified configuration source.
      operationId: getAnchor
      parameters:
      - $ref: '#/components/parameters/ConfigurationTypeParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationAnchorContainer'
          description: the configuration anchor
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: CS administrator views the anchor of a configuration source
      tags:
      - configuration-source-anchors
    servers:
    - description: basepath for API v1
      url: /api/v1
  /configuration-sources/{configuration_type}/anchor/download:
    get:
      description: Administrator downloads the configuration anchor information of a specified configuration source.
      operationId: downloadAnchor
      parameters:
      - $ref: '#/components/parameters/ConfigurationTypeParam'
      responses:
        '200':
          content:
            application/xml:
              schema:
                description: configuration anchor file
                format: binary
                type: string
          description: configuration anchor
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: download configuration anchor information
      tags:
      - configuration-source-anchors
    servers:
    - description: basepath for API v1
      url: /api/v1
  /configuration-sources/{configuration_type}/anchor/re-create:
    put:
      description: Administrator re-creates the configuration anchor of a specified configuration source.
      operationId: reCreateAnchor
      parameters:
      - $ref: '#/components/parameters/ConfigurationTypeParam'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationAnchor'
          description: the new configuration anchor resource
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: re-create the configuration source anchor file
      tags:
      - configuration-source-anchors
    servers:
    - description: basepath for API v1
      url: /api/v1
components:
  responses:
    NotFound:
      description: resource requested does not exists
    Forbidden:
      description: request has been refused
    Unauthorized:
      description: authentication credentials are missing
    InternalServerError:
      description: internal server error
    BadRequest:
      description: request was invalid
  parameters:
    ConfigurationTypeParam:
      in: path
      name: configuration_type
      description: the type of the configuration for which the anchor is fetched for
      required: true
      schema:
        $ref: '#/components/schemas/ConfigurationType'
  schemas:
    ConfigurationAnchor:
      allOf:
      - $ref: '#/components/schemas/ModificationTimestamps'
      description: global conf anchor
      properties:
        hash:
          description: anchor hash
          example: 42:34:C3:22:55:42:34:C3:22:55:42:34:C3:22:55:42:34:C3:22:55:42:34:C3:22:55:42:34:C3
          format: hash
          maxLength: 255
          minLength: 1
          type: string
      required:
      - hash
      - created_at
      type: object
    ModificationTimestamps:
      description: created_at and updated_at timestamps
      properties:
        created_at:
          description: object creation time
          example: '2022-01-20T00:00:00.001Z'
          format: date-time
          readOnly: true
          type: string
        updated_at:
          description: last time updated
          example: '2022-01-22T07:30:00.001Z'
          format: date-time
          readOnly: true
          type: string
      type: object
    ConfigurationAnchorContainer:
      type: object
      description: Container object for configuration anchor, in case central server isn't fully initialized it may not contain anchor.
      properties:
        anchor:
          $ref: '#/components/schemas/ConfigurationAnchor'
    ConfigurationType:
      description: configuration type
      enum:
      - INTERNAL
      - EXTERNAL
      example: INTERNAL
      type: string
  securitySchemes:
    ApiKeyAuth:
      description: X-Road-ApiKey token=<api key>
      in: header
      name: Authorization
      type: apiKey
x-refined-from:
- central-server-admin-openapi.yaml
- x-road-global-central-server-admin-openapi.yml