X-Road (NIIS) Configuration Parts API

resources related to Configuration Parts

Documentation GitHub OpenAPI

Operations 3

GET /configuration-sources/{configuration_type}/configuration-parts CS administrator views the configuration parts of a configuration source #

POST /configuration-sources/{configuration_type}/configuration-parts CS administrator uploads additional configuration parts file #

GET /configuration-sources/{configuration_type}/configuration-parts/{content_identifier}/{version}/download download a configuration parts file #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/x-road-global/openapi/x-road-global-configuration-parts-api-openapi.yml

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-parts-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.

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  title: X Road Global Configuration Parts 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-parts 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-parts
  description: resources related to Configuration Parts
paths:
  /configuration-sources/{configuration_type}/configuration-parts:
    parameters:
    - $ref: '#/components/parameters/ConfigurationTypeParam'
    get:
      description: Administrator views the configuration parts of a specified configuration source.
      operationId: getConfigurationParts
      responses:
        '200':
          content:
            application/json:
              schema:
                description: array of configuration parts
                items:
                  $ref: '#/components/schemas/ConfigurationPart'
                type: array
                uniqueItems: false
          description: global conf parts
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: CS administrator views the configuration parts of a configuration source
      tags:
      - configuration-parts
    post:
      description: Administrator uploads additional configuration parts file. Note - only supported for ConfigurationType = INTERNAL
      operationId: uploadConfigurationParts
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ConfigurationPartUpload'
        description: new additional configuration parts file to add
        required: true
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: CS administrator uploads additional configuration parts file
      tags:
      - configuration-parts
    servers:
    - description: basepath for API v1
      url: /api/v1
  /configuration-sources/{configuration_type}/configuration-parts/{content_identifier}/{version}/download:
    get:
      description: Administrator downloads a configuration parts file.
      operationId: downloadConfigurationParts
      parameters:
      - $ref: '#/components/parameters/ConfigurationTypeParam'
      - description: the content identifier of the configuration part
        in: path
        name: content_identifier
        required: true
        schema:
          $ref: '#/components/schemas/ConfigurationPartContentIdentifier'
      - description: version of the configuration part. 0 = all versions
        in: path
        name: version
        required: true
        schema:
          example: 2
          format: int32
          minimum: 0
          type: integer
      responses:
        '200':
          content:
            application/xml:
              schema:
                description: configuration parts file
                format: binary
                type: string
          description: configuration parts file
        '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 a configuration parts file
      tags:
      - configuration-parts
    servers:
    - description: basepath for API v1
      url: /api/v1
components:
  responses:
    NotFound:
      description: resource requested does not exists
    NoContent:
      description: request was successful
    Forbidden:
      description: request has been refused
    Unauthorized:
      description: authentication credentials are missing
    InternalServerError:
      description: internal server error
    BadRequest:
      description: request was invalid
  schemas:
    ConfigurationPartUpload:
      description: configuration parts file
      properties:
        content_identifier:
          $ref: '#/components/schemas/ConfigurationPartContentIdentifier'
        file:
          format: binary
          type: string
      required:
      - file
      - content_identifier
      type: object
    ConfigurationPartContentIdentifier:
      description: the content identifier of a globalconf configuration part
      example: SHARED-PARAMETERS
      format: text
      minLength: 1
      type: string
    ConfigurationPart:
      description: configuration part
      properties:
        content_identifier:
          $ref: '#/components/schemas/ConfigurationPartContentIdentifier'
        file_name:
          example: shared-params.xml
          format: filename
          maxLength: 255
          minLength: 1
          type: string
        optional:
          description: if the part is optional
          example: true
          type: boolean
        file_updated_at:
          description: file updated at
          example: '2022-01-12T00:00:00.001Z'
          format: date-time
          maxLength: 24
          minLength: 24
          type: string
        version:
          description: version of the conf part
          example: 3
          format: text
          minLength: 1
          type: integer
      required:
      - content_identifier
      - file_name
      - file_updated_at
      - version
      - optional
      type: object
    ConfigurationType:
      description: configuration type
      enum:
      - INTERNAL
      - EXTERNAL
      example: INTERNAL
      type: string
  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'
  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