# Eclipse Ditto ## HTTP API - [Eclipse Ditto™ HTTP API](https://sourcey-ditto.pages.dev/http-api-doc.md): The HTTP API follows REST conventions and provides a resource-based interface for managing Things, Policies and Connections. You send standard HTTP requests (GET, PUT, POST, PATCH, DELETE) and receive JSON responses. Use it for request and response interactions: managing Things, Features, Policies and Connections,… - [Retrieve visible things or things with specified IDs](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-get.md): Returns all visible things or things passed in by the required parameter ids, which you (the authorized subject) are allowed to read. - [Create a new thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-post.md): Creates a thing with a default thingId and a default policyId. - [Retrieve a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-get.md): Returns the thing identified by the thingId path parameter. The response includes details about the thing, including the policyId, attributes, definition and features. - [Create or update a thing with a specified ID](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-put.md): Create or update the thing specified by the thingId path parameter and the optional JSON body. - [Delete a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-delete.md): Deletes the thing identified by the thingId path parameter. - [Create or patch a thing with a specified ID](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-patch.md): Create or patch an existing thing specified by the thingId path parameter. - [Update the definition of an existing Thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-migratedefinition-post.md): Updates the definition of the specified thing by providing a new definition URL along with an optional migration payload. - [Retrieve the definition of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-definition-get.md): Returns the definition of the thing identified by the thingId path parameter. - [Create or update the definition of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-definition-put.md): * If the thing does not have a definition yet, this request will create it. * If the thing already has a definition you can assign it to a new one by setting the new definition in the request body. - [Delete the definition of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-definition-delete.md): Deletes the definition of the thing identified by the thingId. - [Patch the definition of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-definition-patch.md): Notice that the null value in the JSON body has a special meaning and will delete the definition from the thing. For further documentation see RFC 7396. - [Retrieve the policy ID of a thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-policyid-get.md): Returns the policy ID of the thing identified by the thingId path parameter. - [Update the policy ID of a thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-policyid-put.md): Update the policy ID of the thing identified by the thingId path parameter. - [Patch the policy ID of a thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-policyid-patch.md): Patch the policy ID of the thing identified by the thingId path parameter. - [List all attributes of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-attributes-get.md): Returns all attributes of the thing identified by the thingId path parameter. - [Create or update all attributes of a specific thing at once](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-attributes-put.md): Create or update the attributes of a thing identified by the thingId path parameter. The attributes will be overwritten - all at once - with the content (JSON) set in the request body. - [Delete all attributes of a specific thing at once](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-attributes-delete.md): Deletes all attributes of the thing identified by the thingId path parameter. - [Patch all attributes of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-attributes-patch.md): Patch the attributes of a thing identified by the thingId path parameter. The existing attributes will be merged with the JSON content set in the request body. - [Retrieve a specific attribute of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-attributes-attributepath-get.md): Returns a specific attribute of the thing identified by the thingId path parameter. - [Create or update a specific attribute of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-attributes-attributepath-put.md): Create or update a specific attribute of the thing identified by the thingId path parameter. - [Delete a specific attribute of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-attributes-attributepath-delete.md): Deletes a specific attribute of the thing identified by the thingId path parameter. - [Patch a specific attribute of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-attributes-attributepath-patch.md): Patch a specific attribute of a thing identified by the thingId path parameter. - [List all features of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-get.md): Returns all features of the thing identified by the thingId path parameter. - [Create or modify all features of a specific thing at once](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-put.md): Create or modify all features of a thing identified by the thingId path parameter. - [Delete all features of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-delete.md): Deletes all features of the thing identified by the thingId path parameter. - [Patch all features of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-patch.md): Patch all features of a thing identified by the thingId path parameter. - [Retrieve a specific feature of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-get.md): Returns a specific feature identified by the featureId path parameter of the thing identified by the thingId path parameter. - [Create or modify a specific feature of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-put.md): Create or modify a specific feature identified by the featureId path parameter of the thing identified by the thingId path parameter. - [Delete a specific feature of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-delete.md): Deletes a specific feature identified by the featureId path parameter of the thing identified by the thingId path parameter. - [Patch a specific feature of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-patch.md): Patch a specific feature identified by the featureId path parameter of a thing identified by the thingId path parameter. - [List the definition of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-definition-get.md): Returns the complete definition field of the feature identified by the thingId and featureId path parameter. - [Create or update the definition of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-definition-put.md): Create or update the complete definition of a feature identified by the thingId and featureId path parameter. - [Delete the definition of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-definition-delete.md): Deletes the complete definition of the feature identified by the thingId and featureId path parameter. - [Patch the definition of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-definition-patch.md): Patch the definition of a feature identified by the thingId and featureId path parameter. - [List all properties of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-properties-get.md): Returns all properties of the feature identified by the thingId and featureId path parameter. - [Create or update all properties of a feature at once](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-properties-put.md): Create or update the properties of a feature identified by the thingId and featureId path parameter. - [Delete all properties of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-properties-delete.md): Deletes all properties of the feature identified by the thingId and featureId path parameter. - [Patch all properties of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-properties-patch.md): Patch the properties of a feature identified by the thingId and featureId path parameter. - [Retrieve a specific property of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-properties-propertypath-get.md): Returns the a specific property path of the feature identified by the thingId and featureId path parameter. - [Create or update a specific property of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-properties-propertypath-put.md): Create or update a specific property of a feature identified by the thingId and featureId path parameter. - [Delete a specific property of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-properties-propertypath-delete.md): Deletes a specific property of the feature identified by the thingId and featureId path parameter. - [Patch a specific property of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-properties-propertypath-patch.md): Patch a specific property of a feature identified by the thingId and featureId path parameter. - [List all desired properties of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-desiredproperties-get.md): Returns all desired properties of the feature identified by the thingId and featureId path parameter. - [Create or update all desired properties of a feature at once](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-desiredproperties-put.md): Create or update the desired properties of a feature identified by the thingId and featureId path parameter. - [Delete all desired properties of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-desiredproperties-delete.md): Deletes all desired properties of the feature identified by the thingId and featureId path parameter. - [Patch all desired properties of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-desiredproperties-patch.md): Patch the desired properties of a feature identified by the thingId and featureId path parameter. - [Retrieve a specific desired property of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-desiredproperties-propertypath-get.md): Returns the a specific desired property path of the feature identified by the thingId and featureId path parameter. - [Create or update a specific desired property of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-desiredproperties-propertypath-put.md): Create or update a specific desired property of a feature identified by the thingId and featureId path parameter. - [Delete a specific desired property of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-desiredproperties-propertypath-delete.md): Deletes a specific desired property of the feature identified by the thingId and featureId path parameter. - [Patch a specific desired property of a feature](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-desiredproperties-propertypath-patch.md): Patch a specific desired property of a feature identified by the thingId and featureId path parameter. - [Initiates claiming a specific thing in order to gain access](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-inbox-claim-post.md): A claiming process may enable an end-user to claim things and proof ownership thereof. Such a process is initially triggered via a claim message. This message can be sent to the things service with the HTTP API or the things-client. - [Send a message TO a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-inbox-messages-messagesubject-post.md): A message can be sent to a thing or one of its features in order to invoke an operation on the device. - [Send a message FROM a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-outbox-messages-messagesubject-post.md): Send a message with the subject messageSubject from the thing identified by the thingId path parameter. The request body contains the message payload and the Content-Type header defines its type. - [Send a message TO a specific feature of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-inbox-messages-messagesubject-post.md): Send a message with the subject messageSubject to the feature specified by the featureId and thingId path parameter. The request body contains the message payload and the Content-Type header defines its type. - [Send a message FROM a specific feature of a specific thing](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-things-thingid-features-featureid-outbox-messages-messagesubject-post.md): Send a message with the subject messageSubject from the feature specified by the featureId and thingId path parameter. The request body contains the message payload and the Content-Type header defines its type. - [Retrieve a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-get.md): Returns the complete policy identified by the policyId path parameter. The response contains the policy as JSON object. - [Create or update a policy with a specified ID](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-put.md): Create or update the policy specified by the policyId path parameter. - [Delete a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-delete.md): Deletes the policy identified by the policyId path parameter. Deleting a policy does not implicitly delete other entities (e.g. things) which use this policy. - [Activate subjects for this policy derived from the token](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-actions-activatetokenintegration-post.md): This action only works when authenticated with a Json Web Token (JWT). - [Deactivate subjects for this policy derived from the token](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-actions-deactivatetokenintegration-post.md): This action only works when authenticated with a Json Web Token (JWT). - [Retrieve the entries of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-get.md): Returns all policy entries of the policy identified by the policyId path parameter. - [Modify the entries of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-put.md): Modify the policy entries of the policy identified by the policyId path parameter. - [Retrieve the entries of a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-get.md): Returns all entries (subjects, resources, etc.) of the policy identified by the policyId path parameter, and by the label path parameter. Example label: DEFAULT. - [Create or modify the entries of a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-put.md): Create or modify the policy entry identified by the policyId path parameter and with the label identified by the label path parameter. - [Delete the entries of a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-delete.md): Deletes the entry of the policy identified by the policyId path parameter and with the label identified by the label path parameter. - [Activate a subject for this policy entry derived from the token](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-actions-activatetokenintegration-post.md): This action only works when authenticated with a Json Web Token (JWT). - [Deactivate a subject for this policy entry derived from the token](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-actions-deactivatetokenintegration-post.md): This action only works when authenticated with a Json Web Token (JWT). - [Retrieve all Subjects for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-subjects-get.md): Returns all subject entries of the policy identified by the policyId path parameter, and by the label path parameter. - [Create or modify all Subjects for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-subjects-put.md): Create or modify at once ALL subjects of the policy entry identified by the policyId path parameter, and by the label path parameter. - [Retrieve one specific Subject for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-subjects-subjectid-get.md): Returns the subject with ID subjectId of the policy entry identified by the policyId path parameter, and by the label path parameter. - [Create or modify one specific Subject for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-subjects-subjectid-put.md): Create or modify the subject with ID subjectId of the policy identified by the policyId path parameter, and by the label path parameter. - [Delete one specific Subject for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-subjects-subjectid-delete.md): Deletes the subject with ID subjectId from the policy identified by the policyId path parameter and by the label path parameter. - [Retrieve all Resources for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-resources-get.md): Returns all resource entries of the policy identified by the policyId path parameter, and by the label path parameter. - [Create or modify all Resources for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-resources-put.md): Create or modify all resources of the policy identified by the policyId path parameter, and by the label path parameter. - [Retrieve one specific Resource for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-resources-resourcepath-get.md): Returns the resource with path resourcePath of the policy identified by the policyId path parameter, and by the label path parameter. - [Create or modify one specific Resource for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-resources-resourcepath-put.md): Create or modify the Resource with path resourcePath of the policy entry identified by the label path parameter belonging to the policy identified by the policyId path parameter. - [Delete one specific Resource for a specific Label of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-resources-resourcepath-delete.md): Deletes the resource with path resourcePath from the policy identified by the the policyId path parameter, and by the label path parameter. - [Retrieve the allowed import additions for a specific policy entry](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-allowedadditions-get.md): Returns the allowed import additions of the policy entry identified by the policyId path parameter and the label path parameter. - [Modify the allowed import additions for a specific policy entry](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-allowedadditions-put.md): Modify the allowed import additions of the policy entry identified by the policyId path parameter and the label path parameter. - [Retrieve the namespace patterns for a specific policy entry](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-namespaces-get.md): Returns the namespace patterns of the policy entry identified by the policyId path parameter and the label path parameter. - [Modify the namespace patterns for a specific policy entry](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-namespaces-put.md): Modify the namespace patterns of the policy entry identified by the policyId path parameter and the label path parameter. - [Retrieve the importable type for a specific policy entry](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-importable-get.md): Returns the importable type of the policy entry identified by the policyId path parameter and the label path parameter. - [Modify the importable type for a specific policy entry](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-importable-put.md): Modify the importable type of the policy entry identified by the policyId path parameter and the label path parameter. - [Retrieve the imports of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-get.md): Returns all policy imports of the policy identified by the policyId path parameter. - [Modify the imports of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-put.md): Modify the policy imports of the policy identified by the policyId path parameter. - [Delete all imports of a specific policy](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-delete.md): Removes all imports from the policy identified by the policyId path parameter. If any entry references point to an import, the deletion is rejected. - [Retrieve a specific policy import.](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-importedpolicyid-get.md): Returns the policy import of the policy identified by the policyId path parameter and imported policy identified by the importedPolicyId path parameter. - [Create or modify a specific policy import of a policy.](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-importedpolicyid-put.md): Create or modify the policy import of a specific policy identified by the policyId path parameter and the imported policy identified by the importedPolicyId path parameter. - [Delete a specific policy import.](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-importedpolicyid-delete.md): Deletes a specific policy import identified by the policyId path parameter and the importedPolicyId path parameter. - [Retrieve the entries of a specific policy import](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-importedpolicyid-entries-get.md): Returns the entries (imported labels) of the policy import identified by the policyId path parameter and the importedPolicyId path parameter. - [Modify the entries of a specific policy import](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-importedpolicyid-entries-put.md): Modify the entries (imported labels) of the policy import identified by the policyId path parameter and the importedPolicyId path parameter. - [Retrieve the transitive resolution policy IDs of a specific policy import](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-importedpolicyid-transitiveimports-get.md): Returns the "transitiveImports" array of the policy import identified by the policyId path parameter and the importedPolicyId path parameter. - [Modify the transitive resolution policy IDs of a specific policy import](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-imports-importedpolicyid-transitiveimports-put.md): Modify the "transitiveImports" array of the policy import identified by the policyId path parameter and the importedPolicyId path parameter. - [Retrieve the references of a specific policy entry](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-references-get.md): Returns the references of the policy entry identified by the policyId path parameter and the label path parameter. - [Modify the references of a specific policy entry](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-references-put.md): Sets the references of the policy entry identified by the policyId path parameter and the label path parameter. - [Remove all references from a specific policy entry](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-policies-policyid-entries-label-references-delete.md): Removes all references from the policy entry identified by the policyId path parameter and the label path parameter. - [Retrieve information about the current caller](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-whoami-get.md): Get information about the current caller, e.g. the auth subjects that are generated for the caller. - [Check permissions for specified entities](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-checkpermissions-post.md): This endpoint allows you to verify permissions for various entities on specific resources. - [Search for things](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-search-things-get.md): This resource can be used to search for things. - [Search for things](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-search-things-post.md): This resource can be used to search for things. - [Count things](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-search-things-count-get.md): This resource can be used to count things. - [Count things](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-search-things-count-post.md): This resource can be used to count things. - [Processes a CloudEvent sent in Ditto Protocol](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-cloudevents-post.md): Provides an endpoint accepting CloudEvents via its HTTP protocol binding in Ditto Protocol JSON. - [Retrieve all connections](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-connections-get.md): Returns all connections. - [Create a new connection](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-connections-post.md): Creates the connection defined in the JSON body. The ID of the connection will be generated by the backend. Any ID specified in the request body is therefore prohibited. Supported connection types are amqp-091, amqp-10, mqtt, mqtt-5, kafka, hono and http-push. - [Retrieve a specific connection](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-connections-connectionid-get.md): Returns the connection identified by the connectionId path parameter. - [Create or update a connection with a specified ID](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-connections-connectionid-put.md): Update the connection identified by the connectionId path parameter. - [Delete a specific connection](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-connections-connectionid-delete.md): Delete the connection identified by the connectionId path parameter. - [Send a command to a specific connection](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-connections-connectionid-command-post.md): Sends the command specified in the body to the connection identified by the connectionId path parameter. - [Retrieve status of a specific connection](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-connections-connectionid-status-get.md): Returns the status of the connection identified by the connectionId path parameter. - [Retrieve metrics of a specific connection](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-connections-connectionid-metrics-get.md): Returns the metrics of the connection identified by the connectionId path parameter. - [Retrieve logs of a specific connection](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-api-2-connections-connectionid-logs-get.md): Returns the logs of the connection identified by the connectionId path parameter. Before log entries are generated and returned, logging needs be enabled with the command connectivity.commands:enableConnectionLogs. When creating or opening an connection the logging is enabled per default. This allows to log possible… - [Retrieve all currently configured log levels](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-logging-get.md): Return configured log level for all ditto cluster pod - [Update log levels](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-logging-put.md): Modify log level for eatch pods menaged - [Retrieve currently configured log levels for a specific module](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-logging-modulename-get.md): Return the configured log - [Update log levels for a specific module](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-logging-modulename-put.md): Return outcome modify log level for a specific module - [Retrieve the configuration at the specified path parameter](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-config-get.md): It is recommended to not omit the query parameter path. Otherwise, the full configurations of all services are aggregated in the response, which can become megabytes big. - [Retrieving the configuration of a specific service instance.](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-config-modulename-podname-get.md): Return the configuration of a specific service instance. - [Send a piggyback command](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-piggyback-post.md): Send a piggyback command to Pekko’s pub-sub-mediator - [Send a piggyback command to a specific service](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-piggyback-servicename-post.md): POST /devops/piggyback/{serviceName}: takes BasePiggybackCommandRequestSchema, returns PiggybackManagingBackgroundCleanup. - [Send a piggyback command to a specific instance of service](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-piggyback-servicename-instanceindex-post.md): POST /devops/piggyback/{serviceName}/{instanceIndex}: takes BasePiggybackCommandRequestSchema. - [Retrieve WoT Thing Directory](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-well-known-wot-get.md): Returns a WoT (Web of Things) Thing Description of the Ditto Thing Directory, as specified by the WoT Discovery specification. - [Retrieve WoT Thing Directory headers](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-well-known-wot-head.md): Returns headers for the WoT Thing Directory endpoint without a response body. Supports the same authentication and configuration as the GET method. - [Get the WoT validation config](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-wot-config-get.md): GET /devops/wot/config: returns WotValidationConfig. - [Update the WoT validation config](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-wot-config-put.md): PUT /devops/wot/config: takes WotValidationConfig. - [Delete the WoT validation config](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-wot-config-delete.md): DELETE /devops/wot/config. - [Get the merged WoT validation config](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-wot-config-merged-get.md): GET /devops/wot/config/merged: returns WotValidationConfig. - [List all dynamic WoT validation config sections](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-wot-config-dynamicconfigs-get.md): GET /devops/wot/config/dynamicConfigs: returns a list of DynamicValidationConfig. - [Get a dynamic WoT validation config section by scopeId](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-wot-config-dynamicconfigs-scopeid-get.md): GET /devops/wot/config/dynamicConfigs/{scopeId}: returns DynamicValidationConfig. - [Create or update a dynamic WoT validation config section](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-wot-config-dynamicconfigs-scopeid-put.md): PUT /devops/wot/config/dynamicConfigs/{scopeId}: takes DynamicValidationConfig. - [Delete a dynamic WoT validation config section](https://sourcey-ditto.pages.dev/http-api-doc/operations/operation-devops-wot-config-dynamicconfigs-scopeid-delete.md): DELETE /devops/wot/config/dynamicConfigs/{scopeId}. - [Error](https://sourcey-ditto.pages.dev/http-api-doc/models/error.md): Fields: status, message, description and href. - [AdvancedError](https://sourcey-ditto.pages.dev/http-api-doc/models/advancederror.md): Fields: status, error, message, description and href. - [Attributes](https://sourcey-ditto.pages.dev/http-api-doc/models/attributes.md): An arbitrary JSON object describing the attributes of a thing. - [Definition](https://sourcey-ditto.pages.dev/http-api-doc/models/definition.md): A single fully qualified identifier of a definition in the form '::' or a valid HTTP(s) URL - [FeatureDefinition](https://sourcey-ditto.pages.dev/http-api-doc/models/featuredefinition.md): The definitions of a feature. - [FeatureProperties](https://sourcey-ditto.pages.dev/http-api-doc/models/featureproperties.md): An arbitrary JSON object describing the properties of a feature. - [FeatureDesiredProperties](https://sourcey-ditto.pages.dev/http-api-doc/models/featuredesiredproperties.md): An arbitrary JSON object describing the desired properties of a feature. - [Feature](https://sourcey-ditto.pages.dev/http-api-doc/models/feature.md): Fields: definition, properties and desiredProperties. - [SearchResultThings](https://sourcey-ditto.pages.dev/http-api-doc/models/searchresultthings.md): Fields: items and cursor. - [SearchResultThingsCount](https://sourcey-ditto.pages.dev/http-api-doc/models/searchresultthingscount.md): SearchResultThingsCount - [NewThing](https://sourcey-ditto.pages.dev/http-api-doc/models/newthing.md): Fields: _policy, _copyPolicyFrom, policyId, definition, attributes and features. - [PatchThing](https://sourcey-ditto.pages.dev/http-api-doc/models/patchthing.md): Fields: thingId, policyId, definition, attributes and features. - [Thing](https://sourcey-ditto.pages.dev/http-api-doc/models/thing.md): Fields: thingId, policyId, definition, attributes, features, _revision and 3 more. - [MigrateThingDefinitionRequest](https://sourcey-ditto.pages.dev/http-api-doc/models/migratethingdefinitionrequest.md): JSON payload to migrate the definition of a Thing. - [MigrateThingDefinitionResponse](https://sourcey-ditto.pages.dev/http-api-doc/models/migratethingdefinitionresponse.md): Response payload after applying or simulating a migration to a Thing. - [NewPolicy](https://sourcey-ditto.pages.dev/http-api-doc/models/newpolicy.md): Policy consisting of policy entries - [Policy](https://sourcey-ditto.pages.dev/http-api-doc/models/policy.md): Policy consisting of policy entries - [PolicyImports](https://sourcey-ditto.pages.dev/http-api-doc/models/policyimports.md): Policy imports containing one policy import for each key. The key is the policy ID of the referenced policy. - [PolicyImport](https://sourcey-ditto.pages.dev/http-api-doc/models/policyimport.md): Single policy import defining which policy entries of the referenced policy are imported. - [Importable](https://sourcey-ditto.pages.dev/http-api-doc/models/importable.md): Controls the import behavior of this policy entry i.e. whether this policy entry is implicitly, explicitly or never imported when referenced from another policy. - [PolicyEntries](https://sourcey-ditto.pages.dev/http-api-doc/models/policyentries.md): Policy entries containing one policy entry for each arbitrary label key - [PolicyEntry](https://sourcey-ditto.pages.dev/http-api-doc/models/policyentry.md): Single policy entry. Both subjects and resources are optional — they default to empty when absent. An entry may define references to inherit subjects, resources, and namespaces from other entries (local or imported). - [Subjects](https://sourcey-ditto.pages.dev/http-api-doc/models/subjects.md): A SubjectEntry defines who is addressed. - [SubjectEntry](https://sourcey-ditto.pages.dev/http-api-doc/models/subjectentry.md): Single (Authorization) Subject entry holding its type. - [Resources](https://sourcey-ditto.pages.dev/http-api-doc/models/resources.md): (Authorization) Resources containing one ResourceEntry for each type:path key, type being one of the following thing, policy, message. - [ResourceEntry](https://sourcey-ditto.pages.dev/http-api-doc/models/resourceentry.md): Single (Authorization) Resource entry defining permissions per effect. Allowed effects are grant and revoke. - [Permission](https://sourcey-ditto.pages.dev/http-api-doc/models/permission.md): A Permission allows a certain action on an entity - [AllowedAdditions](https://sourcey-ditto.pages.dev/http-api-doc/models/allowedadditions.md): Defines which types of additions are allowed when this entry is referenced by other entries via references. - [TransitiveImports](https://sourcey-ditto.pages.dev/http-api-doc/models/transitiveimports.md): List of policy IDs from the imported policy's own imports that should be resolved transitively before extracting entries. This enables multi-level import chains where a template policy defines resources and an intermediate policy defines entries with "references" that add local subjects. - [References](https://sourcey-ditto.pages.dev/http-api-doc/models/references.md): An optional list of references to other policy entries. Each reference points to an entry either in the same policy (local reference) or in an imported policy (import reference). When set, subjects, resources, and namespaces from the referenced entries are additively merged into this entry. - [SubjectAnnouncement](https://sourcey-ditto.pages.dev/http-api-doc/models/subjectannouncement.md): Settings for announcements to be made about the subject. - [Features](https://sourcey-ditto.pages.dev/http-api-doc/models/features.md): List of features where the key represents the featureId of each feature. The featureId key must be unique in the list. - [Connection](https://sourcey-ditto.pages.dev/http-api-doc/models/connection.md): Connection - [NewConnection](https://sourcey-ditto.pages.dev/http-api-doc/models/newconnection.md): Fields: name, connectionType, connectionStatus, uri, sources, targets and 8 more. - [Sources](https://sourcey-ditto.pages.dev/http-api-doc/models/sources.md): The subscription sources of this connection - [Source](https://sourcey-ditto.pages.dev/http-api-doc/models/source.md): A subscription source subscribed by this connection - [Targets](https://sourcey-ditto.pages.dev/http-api-doc/models/targets.md): The publish targets of this connection - [Target](https://sourcey-ditto.pages.dev/http-api-doc/models/target.md): A publish target served by this connection - [ConnectionType](https://sourcey-ditto.pages.dev/http-api-doc/models/connectiontype.md): The type of a connection - [ConnectivityStatus](https://sourcey-ditto.pages.dev/http-api-doc/models/connectivitystatus.md): The status of a connection or resource - [PayloadMappingDefinitions](https://sourcey-ditto.pages.dev/http-api-doc/models/payloadmappingdefinitions.md): List of mapping definitions where the key represents the ID of each mapping that can be used in sources and targets to reference a mapping. - [PayloadMappingDefinition](https://sourcey-ditto.pages.dev/http-api-doc/models/payloadmappingdefinition.md): A mapping definition consisting of the used mappingEngine and the options required by this engine. - [MappingContext](https://sourcey-ditto.pages.dev/http-api-doc/models/mappingcontext.md): MappingContext to apply in this connection containing JavaScript scripts mapping from external messages to internal Ditto Protocol messages. Usage of MappingContext is deprecated, use PayloadMappingDefinitions instead. - [ConnectionStatus](https://sourcey-ditto.pages.dev/http-api-doc/models/connectionstatus.md): Status of a connection and its resources - [ResourceStatus](https://sourcey-ditto.pages.dev/http-api-doc/models/resourcestatus.md): The status of a single resource (e.g. a client or a source/target resource) - [ConnectionMetrics](https://sourcey-ditto.pages.dev/http-api-doc/models/connectionmetrics.md): Metrics of a connection - [OverallConnectionMetrics](https://sourcey-ditto.pages.dev/http-api-doc/models/overallconnectionmetrics.md): Overall metrics of the connection - [SourceMetrics](https://sourcey-ditto.pages.dev/http-api-doc/models/sourcemetrics.md): Source metrics of the connection - [TargetMetrics](https://sourcey-ditto.pages.dev/http-api-doc/models/targetmetrics.md): Target metrics of the connection - [InboundMetrics](https://sourcey-ditto.pages.dev/http-api-doc/models/inboundmetrics.md): Metrics of an inbound (e.g. a Source) resource - [OutboundMetrics](https://sourcey-ditto.pages.dev/http-api-doc/models/outboundmetrics.md): Metrics of an outbound (e.g. a Target) resource - [TypedMetric](https://sourcey-ditto.pages.dev/http-api-doc/models/typedmetric.md): Metrics of a single metric type containing "success" and "failure" metrics - [SingleMetric](https://sourcey-ditto.pages.dev/http-api-doc/models/singlemetric.md): Contains a single metric consisting of several time intervals and counter values for those intervals including the last message date. - [ConnectionLogs](https://sourcey-ditto.pages.dev/http-api-doc/models/connectionlogs.md): Log entries of a connection. - [LogEntry](https://sourcey-ditto.pages.dev/http-api-doc/models/logentry.md): Represents a log entry for a connection. - [LogCategory](https://sourcey-ditto.pages.dev/http-api-doc/models/logcategory.md): A category to which the log entry can be referred to. - [LogType](https://sourcey-ditto.pages.dev/http-api-doc/models/logtype.md): The type of a log entry describing during what kind of activity the entry was created. - [LogLevel](https://sourcey-ditto.pages.dev/http-api-doc/models/loglevel.md): Escalation level of a log entry. - [WhoAmI](https://sourcey-ditto.pages.dev/http-api-doc/models/whoami.md): Contains information about the current user and the auth subjects available for the used authentication. - [WhoAmISubject](https://sourcey-ditto.pages.dev/http-api-doc/models/whoamisubject.md): An auth subject that can be used to provide access for a caller (e.g. in subject entries of policies). - [WotThingDescription](https://sourcey-ditto.pages.dev/http-api-doc/models/wotthingdescription.md): A WoT Thing Description version 1.1 - [TextUnauthorizeError](https://sourcey-ditto.pages.dev/http-api-doc/models/textunauthorizeerror.md): TextUnauthorizeError - [RetrieveConfig](https://sourcey-ditto.pages.dev/http-api-doc/models/retrieveconfig.md): Field: gateway. - [RetrieveLoggingConfig](https://sourcey-ditto.pages.dev/http-api-doc/models/retrieveloggingconfig.md): Field: gateway. - [Module](https://sourcey-ditto.pages.dev/http-api-doc/models/module.md): Field: pod. - [LoggingUpdateFields](https://sourcey-ditto.pages.dev/http-api-doc/models/loggingupdatefields.md): Fields: level and logger. - [UpdatedLogLevel](https://sourcey-ditto.pages.dev/http-api-doc/models/updatedloglevel.md): Details of logging configuration - [ModuleUpdatedLogLevel](https://sourcey-ditto.pages.dev/http-api-doc/models/moduleupdatedloglevel.md): Module that has been updated - [ResultUpdateRequest](https://sourcey-ditto.pages.dev/http-api-doc/models/resultupdaterequest.md): Fields: gateway, things-search, policies, things and connectivity. - [ModuleConfigService](https://sourcey-ditto.pages.dev/http-api-doc/models/moduleconfigservice.md): Module - [ResultConfigService](https://sourcey-ditto.pages.dev/http-api-doc/models/resultconfigservice.md): Details of specific service instance. - [RetrieveConfigService](https://sourcey-ditto.pages.dev/http-api-doc/models/retrieveconfigservice.md): Field: gateway. - [BasePiggybackCommandRequestSchema](https://sourcey-ditto.pages.dev/http-api-doc/models/basepiggybackcommandrequestschema.md): Fields: targetActorSelection, headers and piggybackCommand. - [PiggybackManagingBackgroundCleanup](https://sourcey-ditto.pages.dev/http-api-doc/models/piggybackmanagingbackgroundcleanup.md): Fields: targetActorSelection, headers and piggybackCommand. - [SearchFilterProperty](https://sourcey-ditto.pages.dev/http-api-doc/models/searchfilterproperty.md): Note: When using filter operations, only things with the specified properties are returned. For example, the filter ne(attributes/owner, "SID123") will only return things that do have the owner attribute. - [NamespaceProperty](https://sourcey-ditto.pages.dev/http-api-doc/models/namespaceproperty.md): A comma-separated list of namespaces. This list is used to limit the query to things in the given namespaces only. - [ConfigOverrides](https://sourcey-ditto.pages.dev/http-api-doc/models/configoverrides.md): Config overrides for a dynamic config section. - [ValidationContext](https://sourcey-ditto.pages.dev/http-api-doc/models/validationcontext.md): Validation context for dynamic config section. - [ThingValidationConfig](https://sourcey-ditto.pages.dev/http-api-doc/models/thingvalidationconfig.md): Thing validation config. - [FeatureValidationConfig](https://sourcey-ditto.pages.dev/http-api-doc/models/featurevalidationconfig.md): Feature validation config. - [DynamicValidationConfig](https://sourcey-ditto.pages.dev/http-api-doc/models/dynamicvalidationconfig.md): Dynamic config section for request/response. - [WotValidationConfig](https://sourcey-ditto.pages.dev/http-api-doc/models/wotvalidationconfig.md): WoT validation configuration object.