Skip to content

Main Navigation Learn Resources Official Apps API Reference Release Notes

Appearance

Sidebar Navigation

API Reference

HTTP Overview

Actors

POST Send message(s) to actor

Apps

GET Get all apps

PUT Install app version

GET Get app details

POST Activate or deactivate an app

GET Get all files provided by app

GET Get a file from an app

GET Get current settings values for an app

PATCH Update settings for an app using JSON Merge Patch semantics. Keys present with a value are set, keys present with null are cleared, keys not present are left unchanged.

GET WebSocket endpoint for app development mode. Authentication is done via message (first message must be 'auth').

Audit

GET Query audit logs with filtering and pagination

GET Get a single audit log entry by ID

Clients

GET List all OAuth clients

GET Get a specified OAuth client

PUT Create or update an OAuth client

DELETE Delete an OAuth client

PATCH Update client properties (partial update)

PUT Update client ACL (bulk replace)

PUT Update client roles (bulk replace)

DELETE Remove a specific role from a client

GET Get all active sessions for a client

DELETE Revoke a specific session for a client

GET List all secrets

POST Create a new secret

DELETE Revoke a secret

Components

GET Get all components

GET Get a component

POST Create or update a component

DELETE Delete a component

Events

GET GET /events

Files

GET Download a file

PUT Create or update a file

DELETE Delete a file

Graph

GET Get metadata about the graph

POST Query the graph

GET Get metadata about a node type

Ingress

GET Get all ingresses

GET Get an ingress

PUT Create or update an ingress

DELETE Delete an ingress

JobDefinitions

GET Get a job definition

PUT Create a new job

DELETE Delete a job definition

GET Get all job definitions

Jobs

POST Schedule a new job

GET Get job status

DELETE Delete a job

GET Get job statistics

POST Schedule jobs in batch

Me

GET Get the current user's profile

POST Update the current user's profile

POST Change the current user's password

POST Request to change email address (generates verification secret)

POST Validate email verification

GET Get current user's settings

POST Update user's settings

GET Get all Personal Access Tokens (PATs) for the current user

POST Create a new Personal Access Token (PAT)

DELETE Revoke a Personal Access Token (PAT)

Principals

GET List principals

GET Get a principal

PUT Create or update a principal

DELETE Delete a principal

PATCH Update principal properties (partial update)

POST Reset a principal's password

POST Suspend a principal

POST Reactivate a suspended principal

DELETE Remove a specific role from a principal

GET Get all active sessions for a principal

DELETE Revoke a specific session for a principal

PUT Update principal ACL (bulk replace)

PUT Update principal roles (bulk replace)

Registry

GET Get all registry values

POST Set multiple values at once

GET Get a value or list of all sub-values

POST Set the value of a registry key

DELETE Delete a registry key

Roles

GET List all roles with filtering, search, and cursor-based pagination

GET Gets the specified role

PUT Create or update a role

DELETE Delete a role

PATCH Update role description (partial update)

PUT Update role ACL (bulk replace)

Rules

GET Get all rules

GET Get a rule or all rules matching prefix based on the search type

POST Create or update a rule

DELETE Delete a rule

Sendings

POST Queue an email for delivery

GET Get sending status and details

DELETE Cancel a pending sending

Update role description (partial update)

PATCH

/resources/iam/roles/{roleKey}

Parameters

Path Parameters

roleKey*

Type

string

Required

Request Body

JSON

{

"description": "string",

"etag": "string"

}

Responses

OK

PATCH

/resources/iam/roles/{roleKey}

Samples

Pager

Previous page DELETE Delete a role

Next page PUT Update role ACL (bulk replace)

© 2024 Hantera AB. All rights reserved.

Org. no.: 559242-9582 | VAT no.: SE559242958201