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

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 Trusted 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 trusted-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: trusted-anchors
  description: resources related to Trusted Anchors
paths:
  /trusted-anchors:
    get:
      description: Administrator views the trusted anchors.
      operationId: getTrustedAnchors
      responses:
        '200':
          content:
            application/json:
              schema:
                description: array of trusted anchor objects
                items:
                  $ref: '#/components/schemas/TrustedAnchor'
                type: array
                uniqueItems: false
          description: list of anchors
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: CS administrator views the trusted anchors
      tags:
      - trusted-anchors
    post:
      description: Administrator uploads a new additional trusted anchor.
      operationId: uploadTrustedAnchor
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TrustedAnchorFile'
        description: Trusted anchor to add
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrustedAnchor'
          description: the new trusted anchor resource
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: CS administrator uploads a new additional trusted anchor
      tags:
      - trusted-anchors
    servers:
    - description: basepath for API v1
      url: /api/v1
  /trusted-anchors/preview:
    post:
      description: Administrator uploads a trusted anchor file for preview.
      operationId: previewTrustedAnchor
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/TrustedAnchorFile'
        description: Trusted anchor to preview
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TrustedAnchor'
          description: the trusted anchor
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: CS administrator uploads a trusted anchor file for preview
      tags:
      - trusted-anchors
    servers:
    - description: basepath for API v1
      url: /api/v1
  /trusted-anchors/{hash}:
    delete:
      description: Administrator deletes a trusted anchor.
      operationId: deleteTrustedAnchor
      parameters:
      - $ref: '#/components/parameters/HashParam'
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '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: delete a trusted anchor
      tags:
      - trusted-anchors
    servers:
    - description: basepath for API v1
      url: /api/v1
  /trusted-anchors/{hash}/download:
    get:
      description: Administrator downloads the trusted anchor.
      operationId: downloadTrustedAnchor
      parameters:
      - $ref: '#/components/parameters/HashParam'
      responses:
        '200':
          content:
            application/xml:
              schema:
                description: trusted anchor file
                format: binary
                type: string
          description: trusted 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 trusted anchor
      tags:
      - trusted-anchors
    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:
    TrustedAnchorFile:
      description: Trusted Anchor File
      properties:
        anchor:
          description: the trusted anchor file
          format: binary
          type: string
      required:
      - anchor
    TrustedAnchor:
      description: trusted anchor
      properties:
        instance_identifier:
          description: instance identifier
          example: CS
          format: text
          type: string
        generated_at:
          description: timestamp
          example: '2023-03-17T00:00:00.001Z'
          format: date-time
          readOnly: true
          type: string
        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
      - instance_identifier
      type: object
  parameters:
    HashParam:
      in: path
      name: hash
      description: hash of the trusted anchor
      required: true
      schema:
        format: text
        maxLength: 255
        minLength: 1
        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