Sign in

v1

latestOpenAPI 3.0.2Apache 2.02026-07-1739106293.5 KB
Secondary Services

Publish a new service

Creates a new secondary web service such as a OGC WMS, OGC WCS, OGC API - Features or XYZ tiles.

The secondary web service SHOULD process the underlying data on demand, based on process parameters provided to the user-defined process (through from_parameter references) at run-time, for example for the spatial/temporal extent, resolution, etc. The available process parameters are specified per service type at GET /service_types.

Note: Costs incurred by shared secondary web services are usually paid by the owner, but this depends on the service type and whether it supports charging fees or not.

post/services

Request body

titlestring nullable

A short description to easily distinguish entities.

descriptionstring commonmark nullable

Detailed multi-line description to explain the entity.

CommonMark 0.29 syntax MAY be used for rich text representation.

typestring required

Definition of the service type to access result data. All available service types can be retrieved via GET /service_types. Service types MUST be accepted in a case insensitive manner.

enabledboolean

Describes whether a secondary web service is responding to requests (true) or not (false). Disabled services do not produce any costs.

configurationServiceConfiguration

Map of configuration settings, i.e. the setting names supported by the secondary web service combined with actual values. See GET /service_types for supported configuration settings. For example, this could specify the required version of the service, visualization details or any other service dependent configuration.

planstring nullable

The billing plan to process and charge the job or service with.

Billing plans MUST be accepted in a case insensitive manner. Back-ends MUST resolve the billing plan in the following way:

  • If a non-null value is given: Persist the plan that has been provided in the request.
  • Otherwise:
    1. Persist the default_plan exposed through GET /me, if available.
    2. Persist the default_plan exposed through GET /, if available.
    3. If a single plan is exposed by the back-end, persist it.
    4. Otherwise, the back-end MUST throw a BillingPlanMissing error.

The resolved plan MUST be persisted permanently, regardless of any changes to the exposed billing plans in GET / in the future.

Billing plans not on the list of available plans MUST be rejected with openEO error BillingPlanInvalid.

budgetnumber nullable

Maximum amount of costs the request is allowed to produce. The value MUST be specified in the currency of the back-end. No limits apply, if the value is null or the back-end has no currency set in GET /.

log_level'error' | 'warning' | 'info' | 'debug'

The minimum severity level for log entries that the back-end stores for the processing request.

The order of the levels is as follows (from low to high severity): debug, info, warning, error. That means if warning is set, the back-end will only store log entries with the level warning and error.

The default minimum log level is info. Users need to specifically set this property to debug to capture all log entries. It is RECOMMENDED that users set the level at least to "warning" in production workflows.

Response

The service has been created successfully.