In this page we cover the general structure of the API resources, the supported request types, and expected responses.
For convenience, Application Manager ships with an OpenAPI 2.0 specification and Swagger web client:
- OpenAPI 2.0 specification: https://appmgr:8080/swagger.json
- Swagger web client: http://appmgr:8080/swagger
Both the OpenAPI specification and Swagger web client are not supported and are provided on an as-is basis.
More information on accessing Application Manager.
Application Manager uses the traditional HTTP verbs for CRUD operations on resources. Currently, there is no support for
List resources or request a single resource.
GET /api/v1/<resourcePlural> GET /api/v1/<resourcePlural>/<resourceId>
Create a resource.
Selectively modify an existing resource.
Patch requests follow RFC 7386 by default. Specified attributes in the patch request are merged with existing attributes. If you want to remove an attribute, you specify
As an example, the following request will remove the foo entry and add bar: baz to flinkConfiguration of a Deployment.
spec: template: spec: flinkConfiguration: foo: null bar: baz
Delete a resource.
Note that you can only delete resources that are managed by users. Furthermore, certain resources will require the resource to be in a certain state before you can actually delete them (for instance a Deployment cannot be in state running when you try to delete it).
Each managed resource object has the following structure:
kind: ResourceKind apiVersion: v1 metadata: ... spec: ... status: ...
The metadata and spec parts of resources are managed by users whereas the status is fully managed by the system.
List objects are returned via a List wrapper kind that holds objects in an
items array, e.g. when listing deployments you will receive a resource of kind
DeploymentList with each
Deployment being part of the items array.
kind: KindList apiVersion: v1 items: - kind: Kind metadata: ... spec: ...
The API server expects requests to be made as JSON or YAML and responds as JSON or YAML, respectively. Please use the following media types for request content types (
Content-Type header) and accepted responses (
By default, the API will return JSON.
metadata.resourceVersion attribute of a Deployment resources specifies the current logical version of the resource. You can use this field to check whether a resource has been updated since your last request.
Users must not make any assumptions about how resource versions are updated on resource modifications. If you specify a resource version on a modification, this is currently ignored by the API server. There is currently no way to use this field for concurrency control.
Each resource includes an
apiVersion attribute that specifies the version of the object.
Any structural changes (such as renaming or removing a field) to a resource require a major version upgrade. Therefore, you can assume that your API resources will not break as long as the version is not upgraded.
Minor changes to the API such as adding optional fields or deprecating fields may happen without a version upgrade. Such changes are treated as non-breaking by the API server and therefore don’t require any intervention on your side.
Validation errors are wrapped in
kind: ApiValidationException apiVersion: v1 message: <message> statusCode: <statusCode> errors: - attribute: <attribute> message: <message>
The errors array contains each validation error.
Generic API errors such as a not found resource or a bad request are wrapped in
kind: ApiException apiVersion: v1 message: <message> reason: <reason> statusCode: <statusCode> context: key1: value1
Reason is a short String describing the cause of the error. The context map provides optional context to the error.
200: Successful GET request (get single resource or list).
201: Successful POST request (resource created)
400: Bad request (typically due to an
404: Resource not found (wrapped in
500: Internal error (wrapped in