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.
openapi: 3.2.0
info:
title: Wellknown API
version: v1
description: 'The Wellknown API provides access to a list of globally available provider endpoints.
This API is part of the Sovereign European Cloud API.'
servers:
- description: URL
url: https://demo.secapi.cloud
security:
- bearerAuth: []
tags:
- name: Wellknown
description: Wellknown management
paths:
/.wellknown/secapi:
get:
description: Provides a list of all wellknown providers and endpoints.
operationId: getWellknown
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Wellknown'
description: Successful response
'500':
$ref: '#/components/responses/Error500'
summary: Get wellknown endpoints
tags:
- Wellknown
components:
responses:
Error500:
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error500'
example:
status: 500
type: http://secapi.cloud/errors/internal-server-error
title: Internal Server Error
detail: The server encountered an unexpected condition that prevented it from fulfilling the request.
instance: /errors/500
sources: []
schemas:
ErrorSource:
type: object
description: An object containing references to the source of the error.
required:
- pointer
- parameter
properties:
pointer:
type: string
description: A JSON Pointer [RFC6901] to the associated entity in the request document.
minLength: 1
maxLength: 256
parameter:
type: string
description: A string indicating which URI query parameter caused the error.
minLength: 1
maxLength: 64
WellknownEndpoint:
type: object
description: Represents a global available seca providers and their endpoints.
required:
- provider
- url
properties:
provider:
type: string
minLength: 1
example: seca.region/v1
description: The provider that is available under the given URL.
url:
type: string
minLength: 1
example: https://seca.example.com/region/v1
description: The endpoint URL.
Wellknown:
type: object
description: List of global endpoints related to the seca api.
required:
- version
- endpoints
properties:
version:
type: string
minLength: 1
example: v1
description: Version of the the Wellknown data.
x-extensible-enum:
- v1
endpoints:
type: array
minItems: 1
maxItems: 64
description: All global seca proviers and their endpoints.
items:
$ref: '#/components/schemas/WellknownEndpoint'
example:
- provider: seca.region/v1
url: https://seca.example.com/region/v1
- provider: seca.authorization/v1
url: https://seca.example.com/authorization/v1
- provider: seca.object-storage/v1beta1
url: https://seca.example.com/object-storage/v1beta1
Error:
type: object
description: 'A detailed error response see https://datatracker.ietf.org/doc/html/rfc7807.
'
required:
- type
- title
- status
- detail
- instance
- sources
properties:
type:
type: string
description: The type of error, expressed as a URI.
minLength: 1
maxLength: 4000
example: https://httpstatuses.io/400
title:
type: string
description: 'A short, human-readable summary of the problem
type. It SHOULD NOT change from occurrence to occurrence of the
problem, except for purposes of localization (e.g., using
proactive content negotiation; see [RFC7231], Section 3.4).
'
minLength: 1
maxLength: 1024
status:
type: number
description: 'The HTTP status type ([http://secapi.cloud/errors/-rfc7231], Section 6)
generated by the origin server for this occurrence of the problem.
'
minimum: 100
maximum: 599
example: 400
detail:
type: string
description: A human-readable explanation specific to this occurrence of the problem.
minLength: 1
maxLength: 32768
instance:
type: string
description: 'A URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.
'
minLength: 1
maxLength: 256
sources:
type: array
maxItems: 32
items:
$ref: '#/components/schemas/ErrorSource'
meta:
type: object
description: A meta object containing non-standard meta-information about the error.
Error500:
allOf:
- $ref: '#/components/schemas/Error'
description: A 500 Internal Server Error error response
example:
status: 500
type: http://secapi.cloud/errors/internal-server-error
title: Internal Server Error
detail: The server encountered an unexpected condition that prevented it from fulfilling the request.
instance: /errors/500
sources: []
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Use a JWT token for authentication. The token identifies the user,
and policies (RBAC, ABAC, or hybrid) determine authorization.
'