{"@context": "https://schema.org", "@type": "WebAPI", "name": "IllumiDesk API", "description": "IllumiDesk, an HTTP API described by an OpenAPI document.", "provider": {"@type": "Organization", "name": "illumidesk.com"}, "documentation": "https://raw.githubusercontent.com/3Blades/openapi/master/tbs_swagger.yml"}
Index / APIs / illumidesk.com

IllumiDesk API

IllumiDesk, an HTTP API described by an OpenAPI document.

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: https://api.illumidesk.com

auth: a p i k e y

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

IllumiDesk v1.0

IllumiDesk, an HTTP API described by an OpenAPI document.

methodpathwhat the vendor says it does
POST/auth/jwt-token-auth/Create JSON Web Token (JWT) auth
POST/auth/jwt-token-refresh/Refresh a JSON Web Token (JWT) Obtains a new JSON Web Token using existing user credentials. auth
POST/auth/jwt-token-verify/Validate JSON Web Token (JWT) Checks veraciy of token. auth
POST/auth/register/Register a user User registration requires confirming email address to activate user. auth
GET/v1/meA convenience endpoint that is equivalent to GET /v1/users/profiles// users
GET/v1/servers/options/server-size/Retrieve available server sizes servers
POST/v1/servers/options/server-size/Create a new server size item Only super users with on-premises version have acceess to this endpoint. servers
GET/v1/servers/options/server-size/{size}/Get a server size by id servers
PUT/v1/servers/options/server-size/{size}/Replace a server size by id Only super users with on-premises version have acceess to this endpoint. servers
PATCH/v1/servers/options/server-size/{size}/Update a server size by id Only super users with on-premises version have acceess to this endpoint. servers
DELETE/v1/servers/options/server-size/{size}/Delete a server size by id Only super users with on-premises version have acceess to this endpoint. servers
GET/v1/teams/Get teams teams
POST/v1/teams/Create a new team teams
GET/v1/teams/{team}/Get a team teams
PUT/v1/teams/{team}/Replace a team teams
PATCH/v1/teams/{team}/Update a team teams
DELETE/v1/teams/{team}/Delete a team teams
GET/v1/teams/{team}/billing/invoices/Get team invoices teams billing
GET/v1/teams/{team}/billing/invoices/{id}/Get an invoice teams billing
GET/v1/teams/{team}/billing/invoices/{invoice_id}/invoice-items/Get team invoice items for a given invoice. teams billing
GET/v1/teams/{team}/billing/invoices/{invoice_id}/invoice-items/{id}Get a specific team InvoiceItem. teams billing
GET/v1/teams/{team}/billing/subscriptions/Get active team subscriptons teams billing
POST/v1/teams/{team}/billing/subscriptions/Create a new team subscription teams billing
GET/v1/teams/{team}/billing/subscriptions/{id}/Get team subscriptions teams billing
DELETE/v1/teams/{team}/billing/subscriptions/{id}/Delete a subscription teams billing
GET/v1/teams/{team}/groups/Get team groups teams
GET/v1/teams/{team}/groups/{group}/Get team group teams
PUT/v1/teams/{team}/groups/{group}/Patch team group teams
PATCH/v1/teams/{team}/groups/{group}/Patch team group teams
DELETE/v1/teams/{team}/groups/{group}/Delete team group teams
POST/v1/teams/{team}/groups/{group}/add/Add user to group teams
POST/v1/teams/{team}/groups/{group}/remove/User removed from group teams
GET/v1/users/profiles/Get user list users
POST/v1/users/profiles/Create new user Only admin users can create new users. New users have active status by default. users
GET/v1/users/profiles/{user}/Retrieve a user users
PATCH/v1/users/profiles/{user}/Update a user users
DELETE/v1/users/profiles/{user}/Delete a user users
GET/v1/users/{user}/api-key/Retrieve account's API key users
GET/v1/users/{user}/avatar/Retrieve user's avatar users
POST/v1/users/{user}/avatar/Add user avatar users

and 102 more operation(s) in this specification, all searchable.

specification origin: https://raw.githubusercontent.com/3Blades/openapi/master/tbs_swagger.yml

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.