@datafire/illumidesk v5.0.0

@datafire/illumidesk

Client library for IllumiDesk

Installation and Usage

npm install --save @datafire/illumidesk

let illumidesk = require('@datafire/illumidesk').create({
  jwt: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

auth.jwt_token_auth.post

Create JSON Web Token (JWT)

illumidesk.auth.jwt_token_auth.post({}, context)

Input

• input object
  • jwt_data JWTData

Output

• output JWT

auth.jwt_token_refresh.post

Obtains a new JSON Web Token using existing user credentials.

illumidesk.auth.jwt_token_refresh.post({}, context)

Input

• input object
  • refreshjwt_data RefreshJSONWebTokenData

Output

• output RefreshJSONWebToken

auth.jwt_token_verify.post

Checks veraciy of token.

illumidesk.auth.jwt_token_verify.post({}, context)

Input

• input object
  • verifyjwt_data VerifyJSONWebTokenData

Output

• output VerifyJSONWebToken

oauth_login

illumidesk.oauth_login({
  "provider": ""
}, context)

Input

• input object
  • provider required string (values: github, google, slack): OAuth2 provider

Output

Output schema unknown

auth_register

User registration requires confirming email address to activate user.

illumidesk.auth_register({}, context)

Input

• input object
  • user_data UserData

Output

• output User

me

A convenience endpoint that is equivalent to GET /v1/users/profiles//

illumidesk.me(null, context)

Input

This action has no parameters

Output

• output User

servers_options_sizes_list

Retrieve available server sizes

illumidesk.servers_options_sizes_list({}, context)

Input

• input object
  • limit string: Set limit when retrieving items.
  • offset string: Offset when retrieving items.
  • ordering string: Set order when retrieving items.

Output

• output array
  • items ServerSize

servers_options_server_size_create

Only super users with on-premises version have acceess to this endpoint.

illumidesk.servers_options_server_size_create({}, context)

Input

• input object
  • serversize_data ServerSizeData

Output

• output ServerSize

servers_options_server_size_delete

Only super users with on-premises version have acceess to this endpoint.

illumidesk.servers_options_server_size_delete({
  "size": ""
}, context)

Input

• input object
  • size required string: Server size unique identifier expressed as UUID or name.

Output

Output schema unknown

servers_options_resources_read

Get a server size by id

illumidesk.servers_options_resources_read({
  "size": ""
}, context)

Input

• input object
  • size required string: Server size unique identifier expressed as UUID or name.

Output

• output ServerSize

servers_options_server_size_update

Only super users with on-premises version have acceess to this endpoint.

illumidesk.servers_options_server_size_update({
  "size": ""
}, context)

Input

• input object
  • size required string: Server size unique identifier expressed as UUID or name.
  • serversize_data ServerSizeData

Output

• output ServerSize

servers_options_server_size_replace

Only super users with on-premises version have acceess to this endpoint.

illumidesk.servers_options_server_size_replace({
  "size": ""
}, context)

Input

• input object
  • size required string: Server size unique identifier expressed as UUID or name.
  • serversize_data ServerSizeData

Output

• output ServerSize

teams_list

Get teams

illumidesk.teams_list({}, context)

Input

• input object
  • limit string: Limit when getting data.
  • offset string: Offset when getting data.

Output

• output array
  • items Team

teams_create

Create a new team

illumidesk.teams_create({}, context)

Input

• input object
  • team_data TeamData

Output

• output Team

teams_delete

Delete a team

illumidesk.teams_delete({
  "team": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.

Output

Output schema unknown

teams_read

Get a team

illumidesk.teams_read({
  "team": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.

Output

• output Team

teams_update

Update a team

illumidesk.teams_update({
  "team": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • team_data TeamData

Output

• output Team

teams_replace

Replace a team

illumidesk.teams_replace({
  "team": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • team_data TeamData

Output

• output Team

teams_billing_invoices_list

Get team invoices

illumidesk.teams_billing_invoices_list({
  "team": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • limit string: Limit when getting items.
  • offset string: Offset when getting items.

Output

• output array
  • items Invoice

teams_billing_invoices_read

Get an invoice

illumidesk.teams_billing_invoices_read({
  "team": "",
  "id": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • id required string: Invoice unique identifier expressed as UUID.

Output

• output Invoice

teams_billing_invoice_items_list

Get team invoice items for a given invoice.

illumidesk.teams_billing_invoice_items_list({
  "team": "",
  "invoice_id": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • invoice_id required string: Invoice id, expressed as UUID.
  • limit string: Limit when getting items.
  • offset string: Offset when getting items.
  • ordering string: Ordering when getting items.

Output

• output array
  • items InvoiceItem

teams_billing_invoice_items_read

Get a specific team InvoiceItem.

illumidesk.teams_billing_invoice_items_read({
  "team": "",
  "invoice_id": "",
  "id": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • invoice_id required string: Invoice id, expressed as UUID.
  • id required string: InvoiceItem id, expressed as UUID.

Output

• output InvoiceItem

teams_billing_subscriptions_list

Get active team subscriptons

illumidesk.teams_billing_subscriptions_list({
  "team": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • limit string: Limit when getting items.
  • offset string: Offset when getting items.
  • ordering string: Ordering when getting items.

Output

• output array
  • items Subscription

teams_billing_subscriptions_create

Create a new team subscription

illumidesk.teams_billing_subscriptions_create({
  "team": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • subscription_data SubscriptionData

Output

• output Subscription

teams_billing_subscriptions_delete

Delete a subscription

illumidesk.teams_billing_subscriptions_delete({
  "team": "",
  "id": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • id required string: Subscription unique identifier expressed as UUID.

Output

Output schema unknown

teams_billing_subscriptions_read

Get team subscriptions

illumidesk.teams_billing_subscriptions_read({
  "team": "",
  "id": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • id required string: Unique identifier expressed as UUID.

Output

• output Subscription

teams_groups_list

Get team groups

illumidesk.teams_groups_list({
  "team": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • limit string: Limit when getting data.
  • offset string: Offset when getting data.

Output

• output array
  • items Group

teams_groups_delete

Delete team group

illumidesk.teams_groups_delete({
  "team": "",
  "group": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • group required string: Group unique identifier expressed as UUID or name.

Output

Output schema unknown

teams_groups_read

Get team group

illumidesk.teams_groups_read({
  "team": "",
  "group": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • group required string: Group unique identifier expressed as UUID or name.

Output

• output Group

teams_groups_update

Patch team group

illumidesk.teams_groups_update({
  "team": "",
  "group": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • group required string: Group unique identifier expressed as UUID or name.
  • group_data GroupData

Output

• output Group

teams_groups_replace

Patch team group

illumidesk.teams_groups_replace({
  "team": "",
  "group": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • group required string: Group unique identifier expressed as UUID or name.
  • group_data GroupData

Output

• output Group

teams_groups_add_to_group

Add user to group

illumidesk.teams_groups_add_to_group({
  "team": "",
  "group": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • group required string: Group unique identifier expressed as UUID or name.

Output

• output GroupUser

teams_groups_remove_from_group

User removed from group

illumidesk.teams_groups_remove_from_group({
  "team": "",
  "group": ""
}, context)

Input

• input object
  • team required string: Team unique identifier expressed as UUID or name.
  • group required string: Group unique identifier expressed as UUID or name.

Output

Output schema unknown

users_list

Get user list

illumidesk.users_list({}, context)

Input

• input object
  • limit string: Limit user list.
  • offset string: Offset when getting users.
  • username string: User username.
  • email string: User email.
  • ordering string: Ordering when getting users.

Output

• output array
  • items User

users_create

Only admin users can create new users. New users have active status by default.

illumidesk.users_create({}, context)

Input

• input object
  • user_data UserData

Output

• output User

users_delete

Delete a user

illumidesk.users_delete({
  "user": ""
}, context)

Input

• input object
  • user required string: User identifier expressed as UUID or username.

Output

Output schema unknown

users_read

Retrieve a user

illumidesk.users_read({
  "user": ""
}, context)

Input

• input object
  • user required string: Unique identifier expressed as UUID or username.

Output

• output User

users_update

Update a user

illumidesk.users_update({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier expressed as UUID or username.
  • user_data UserData

Output

• output User

v1.users.user.api_key.get

Retrieve account's API key

illumidesk.v1.users.user.api_key.get({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier expressed as UUID or username.

Output

Output schema unknown

user_avatar_delete

Delete avatar

illumidesk.user_avatar_delete({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier expressed as UUID or username.

Output

Output schema unknown

user_avatar_get

Retrieve user's avatar

illumidesk.user_avatar_get({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier expressed as UUIDor username.

Output

Output schema unknown

user_avatar_update

Update a project file

illumidesk.user_avatar_update({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier expressed as UUID or username.

Output

• output User

user_avatar_set

Add user avatar

illumidesk.user_avatar_set({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier expressed as UUID or username.

Output

• output User

users_emails_list

Retrieve account email addresses

illumidesk.users_emails_list({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier as expressed as UUID or username.
  • limit string: Limite when getting email list.
  • offset string: Offset when getting email list.
  • ordering string: Ordering when getting email list.

Output

• output array
  • items Email

users_emails_create

Create an email address

illumidesk.users_emails_create({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier expressed as UUID or username.
  • email_data EmailData

Output

• output Email

users_emails_delete

Delete an email address

illumidesk.users_emails_delete({
  "email_id": "",
  "user": ""
}, context)

Input

• input object
  • email_id required string: Email unique identifier expressed as UUID.
  • user required string: User unique identifier expressed as UUID or username.

Output

Output schema unknown

users_emails_read

Retrieve a user's email addresses

illumidesk.users_emails_read({
  "email_id": "",
  "user": ""
}, context)

Input

• input object
  • email_id required string: Email unique identifier expressed as UUID.
  • user required string: User unique identifier expressed as UUID or username.

Output

• output Email

users_emails_update

Update an email address

illumidesk.users_emails_update({
  "email_id": "",
  "user": ""
}, context)

Input

• input object
  • email_id required string: Email unique identifier expressed as UUID.
  • user required string: User unique identifier expressed as UUID or username.
  • email_data EmailData

Output

• output Email

users_emails_replace

Replace an email address

illumidesk.users_emails_replace({
  "email_id": "",
  "user": ""
}, context)

Input

• input object
  • email_id required string: Email unique identifier expressed as UUID.
  • user required string: User unique identifier expressed as UUID or username.
  • email_data EmailData

Output

• output Email

v1.users.user.ssh_key.get

Retrieve an SSH key

illumidesk.v1.users.user.ssh_key.get({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier expressed as UUID or username.

Output

Output schema unknown

v1.users.user.ssh_key.reset.post

Recreate an SSH key

illumidesk.v1.users.user.ssh_key.reset.post({
  "user": ""
}, context)

Input

• input object
  • user required string: User unique identifier expressed as UUID or username.

Output

Output schema unknown

billing_cards_list

Get credit cards

illumidesk.billing_cards_list({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • limit string: Set limit when retrieving credit or debit cards.
  • offset string: Set offset when retriving cards.
  • ordering string: Order when retrieving cards.

Output

• output array
  • items Card

billing_cards_create

Create new credit card

illumidesk.billing_cards_create({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • card_data CardDataPost

Output

• output Card

billing_cards_delete

Delete a credit card

illumidesk.billing_cards_delete({
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • id required string: Card unique identifier expressed as UUID.

Output

Output schema unknown

billing_cards_read

Get credit card by id

illumidesk.billing_cards_read({
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • id required string: User unique identifier expressed as UUID.

Output

• output Card

billing_cards_update

Update a credit card

illumidesk.billing_cards_update({
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • id required string: Card unique identifier.
  • card_data CardDataPutandPatch

Output

• output Card

billing_cards_replace

Replace a credit card

illumidesk.billing_cards_replace({
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • id required string
  • card_data CardDataPutandPatch

Output

• output Card

billing_invoices_list

Get invoices

illumidesk.billing_invoices_list({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • limit string: Limit when getting items.
  • offset string: Offset when getting items.
  • ordering string: Ordering when getting items.

Output

• output array
  • items Invoice

billing_invoices_read

Get an invoice

illumidesk.billing_invoices_read({
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • id required string: Invoice unique identifier expressed as UUID.

Output

• output Invoice

billing_invoice_items_list

Get invoice items for a given invoice.

illumidesk.billing_invoice_items_list({
  "namespace": "",
  "invoice_id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • invoice_id required string: Invoice id, expressed as UUID.
  • limit string: Limit when getting items.
  • offset string: Offset when getting items.
  • ordering string: Ordering when getting items.

Output

• output array
  • items InvoiceItem

billing_invoice_items_read

Get a specific InvoiceItem.

illumidesk.billing_invoice_items_read({
  "namespace": "",
  "invoice_id": "",
  "id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • invoice_id required string: Invoice id, expressed as UUID.
  • id required string: InvoiceItem id, expressed as UUID.

Output

• output InvoiceItem

billing_plans_list

Get billing plans

illumidesk.billing_plans_list({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • limit string: Limit when getting items.
  • offset string: Offset when getting items.
  • ordering string: Ordering when getting items.

Output

• output array
  • items Plan

billing_plans_read

Get a billing plan

illumidesk.billing_plans_read({
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • id required string: Plan unique identifier expressed as UUID.

Output

• output Plan

billing_subscriptions_list

Get active subscriptons

illumidesk.billing_subscriptions_list({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • limit string: Limit when getting items.
  • offset string: Offset when getting items.
  • ordering string: Ordering when getting items.

Output

• output array
  • items Subscription

billing_subscriptions_create

Create a new subscription

illumidesk.billing_subscriptions_create({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • subscription_data SubscriptionData

Output

• output Subscription

billing_subscriptions_delete

Delete a subscription

illumidesk.billing_subscriptions_delete({
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • id required string: Subscription unique identifier expressed as UUID.

Output

Output schema unknown

billing_subscriptions_read

Get a subscriptions

illumidesk.billing_subscriptions_read({
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • id required string: Unique identifier expressed as UUID.

Output

• output Subscription

notifications_list

Get notifications of all types and entities for the authenticated user.

illumidesk.notifications_list({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team data.
  • limit string: Limit when getting items.
  • offset string: Offset when getting items.
  • ordering string: Ordering when getting items.
  • read boolean: When true, get only read notifications. When false, get only unread notifications. Default behavior is to return both read and unread.

Output

• output array
  • items Notification

notifications_update_list

Mark a list of notifications as either read or unread.

illumidesk.notifications_update_list({
  "namespace": "",
  "notification_data": {
    "notifications": [],
    "read": true
  }
}, context)

Input

• input object
  • namespace required string: User or team name.
  • notification_data required NotificationListUpdateData

Output

• output Notification

notifications_list_entity

Get notifications of all types and entities for the authenticated user.

illumidesk.notifications_list_entity({
  "namespace": "",
  "entity": ""
}, context)

Input

• input object
  • namespace required string: User or team data.
  • limit string: Limit when getting items.
  • offset string: Offset when getting items.
  • ordering string: Ordering when getting items.
  • entity required string (values: billing): Entity to filter notifications by.
  • read boolean: When true, get only read notifications. When false, get only unread notifications. Default behavior is to return both read and unread.

Output

• output array
  • items Notification

notifications_update_entity_list

Mark a list of notifications as either read or unread.

illumidesk.notifications_update_entity_list({
  "namespace": "",
  "entity": "",
  "notification_data": {
    "notifications": [],
    "read": true
  }
}, context)

Input

• input object
  • namespace required string: User or team name.
  • entity required string (values: billing): Entity to filter notifications by.
  • notification_data required NotificationListUpdateData

Output

• output Notification

notification_settings_read

Retrieve global notification settings for the authenticated user

illumidesk.notification_settings_read({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team data.

Output

• output array
  • items NotificationSettings

notification_settings_update

Modify global notification settings.

illumidesk.notification_settings_update({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • notification_settings_data NotificationSettingsData

Output

• output NotificationSettings

notification_settings_create

Create global notification settings

illumidesk.notification_settings_create({
  "namespace": "",
  "notification_settings_data": {
    "enabled": true,
    "emails_enabled": true
  }
}, context)

Input

• input object
  • namespace required string: User or team name.
  • notification_settings_data required NotificationSettingsData

Output

• output NotificationSettings

notification_settings_entity_read

Retrieve global notification settings for the authenticated user

illumidesk.notification_settings_entity_read({
  "namespace": "",
  "entity": ""
}, context)

Input

• input object
  • namespace required string: User or team data.
  • entity required string (values: billing): Entity whose settings should be retrieved.

Output

• output array
  • items NotificationSettings

notification_settings_entity_update

Modify global notification settings.

illumidesk.notification_settings_entity_update({
  "namespace": "",
  "entity": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • entity required string (values: billing): Entity whose settings should be retrieved.
  • notification_settings_data NotificationSettingsData

Output

• output NotificationSettings

notification_settings_entity_create

Create global notification settings

illumidesk.notification_settings_entity_create({
  "namespace": "",
  "entity": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • entity required string (values: billing): Entity whose settings should be retrieved.
  • notification_settings_data NotificationSettingsData

Output

• output NotificationSettings

notification_read

Retrieve a specific notification.

illumidesk.notification_read({
  "namespace": "",
  "notification_id": ""
}, context)

Input

• input object
  • namespace required string: User or team data.
  • notification_id required string: Notification UUID.

Output

• output Notification

notification_update

Mark a specific notification as either read or unread.

illumidesk.notification_update({
  "namespace": "",
  "notification_id": ""
}, context)

Input

• input object
  • namespace required string: User or team data.
  • notification_id required string: Notification UUID.
  • notification_data NotificationUpdateData

Output

• output Notification

oauth_applications_list

Retrieve oauth applications

illumidesk.oauth_applications_list({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • limit string: Set limit when retrieving items.
  • offset string: Offset when retrieving items.
  • ordering string: Set order when retrieving items.

Output

• output array
  • items Application

oauth_application_create

Create a new OAuth2 application

illumidesk.oauth_application_create({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • application_data ApplicationData

Output

• output Application

oauth_application_delete

Delete an application by id

illumidesk.oauth_application_delete({
  "namespace": "",
  "application": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • application required string: Application unique identifier expressed as UUID or name.

Output

Output schema unknown

oauth_application_read

Get an application by id

illumidesk.oauth_application_read({
  "namespace": "",
  "application": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • application required string: Application unique identifier expressed as UUID or name.

Output

• output Application

oauth_application_update

Update an application by id

illumidesk.oauth_application_update({
  "namespace": "",
  "application": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • application required string: Application unique identifier expressed as UUID or name.
  • application_data ApplicationData

Output

• output Application

oauth_application_replace

Replace an application by id

illumidesk.oauth_application_replace({
  "namespace": "",
  "application": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • application required string: Application unique identifier expressed as UUID or name.
  • oauth_application_data ApplicationData

Output

• output Application

projects_list

Get available projects

illumidesk.projects_list({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • limit string: Limit when getting data.
  • offset string: Offset when getting data.
  • private string: Private project or public project.
  • name string: Project name.
  • ordering string: Ordering when getting projects.

Output

• output array
  • items Project

projects_create

Create a new project

illumidesk.projects_create({
  "namespace": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • project_data ProjectData

Output

• output Project

project_copy_check

Check if you are able to copy a project to your account.

illumidesk.project_copy_check({
  "namespace": "",
  "project_copy_data": {
    "project": ""
  }
}, context)

Input

• input object
  • namespace required string: User or team name.
  • project_copy_data required object
    • project required string: UUID of the project the user wishes to copy.

Output

Output schema unknown

project_copy

Copy a project to your own account.

illumidesk.project_copy({
  "namespace": "",
  "project_copy_data": {
    "project": ""
  }
}, context)

Input

• input object
  • namespace required string: User or team name.
  • project_copy_data required object
    • name string: Name for the newly copied project
    • project required string: UUID of the project the user wishes to copy.

Output

• output Project

projects_delete

Delete a project

illumidesk.projects_delete({
  "namespace": "",
  "project": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • project required string: Project unique identifier expressed as UUID or name.

Output

Output schema unknown

projects_read

Get a project

illumidesk.projects_read({
  "namespace": "",
  "project": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • project required string: Project unique identifier expressed as UUID or name.

Output

• output Project

projects_update

Update a project

illumidesk.projects_update({
  "namespace": "",
  "project": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • project required string: Project unique identifier expressed as UUID or name.
  • project_data ProjectData

Output

• output Project

projects_replace

Replace a project

illumidesk.projects_replace({
  "namespace": "",
  "project": ""
}, context)

Input

• input object
  • namespace required string: User or team namespace.
  • project required string: Project unique identifier expressed as UUID or name.
  • project_data ProjectData

Output

• output Project

projects_collaborators_list

Get project collaborators

illumidesk.projects_collaborators_list({
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • limit string: Limit when retrieving items.
  • offset string: Offset when retrieving items.
  • ordering string: Ordering when retrieving items.

Output

• output array
  • items Collaborator

projects_collaborators_create

Create project collaborators

illumidesk.projects_collaborators_create({
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • collaborator_data CollaboratorData

Output

• output Collaborator

projects_collaborators_delete

Delete a project collaborator

illumidesk.projects_collaborators_delete({
  "project": "",
  "namespace": "",
  "collaborator": ""
}, context)

Input

• input object
  • project required string: Project unique identifier.
  • namespace required string: User or team name.
  • collaborator required string: Collaborator unique identifier.

Output

Output schema unknown

projects_collaborators_read

Get a project collaborator

illumidesk.projects_collaborators_read({
  "project": "",
  "namespace": "",
  "collaborator": ""
}, context)

Input

• input object
  • project required string: Project unique identifier.
  • namespace required string: User or team name.
  • collaborator required string: Collaborator unique identifier expressed as UUID or name.

Output

• output Collaborator

projects_collaborators_update

Update project collaborator

illumidesk.projects_collaborators_update({
  "project": "",
  "namespace": "",
  "collaborator": ""
}, context)

Input

• input object
  • project required string
  • namespace required string: User or team name.
  • collaborator required string
  • collaborator_data CollaboratorData

Output

• output Collaborator

projects_deployments_list

Retrieve deployments

illumidesk.projects_deployments_list({
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • limit string: Limit results when getting deployment list.
  • offset string: Offset results when getting deployment list.
  • name string: Server name.
  • ordering string: Ordering option when getting deployment list.

Output

• output array
  • items Deployment

projects_deployments_create

Create a new deployment

illumidesk.projects_deployments_create({
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • project required string: Project unique identifer expressed as UUID or name.
  • namespace required string: User or team name.
  • deployment_data DeploymentData

Output

• output Deployment

projects_deployment_delete

Delete a deployment

illumidesk.projects_deployment_delete({
  "project": "",
  "namespace": "",
  "deployment": ""
}, context)

Input

• input object
  • project required string: Project unique identifier.
  • namespace required string: User or team name.
  • deployment required string: User unique identifier.

Output

Output schema unknown

projects_deployments_read

Retrieve a deployment

illumidesk.projects_deployments_read({
  "project": "",
  "namespace": "",
  "deployment": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • deployment required string: Deployment unique identifier expressed as UUID or name.

Output

• output Deployment

projects_deployments_update

Update a deployment

illumidesk.projects_deployments_update({
  "project": "",
  "namespace": "",
  "deployment": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • deployment required string: Deployment unique identifier expressed as UUID or name.
  • deployment_data DeploymentData

Output

• output Deployment

projects_deployments_replace

Replace a deployment

illumidesk.projects_deployments_replace({
  "project": "",
  "namespace": "",
  "deployment": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • deployment required string: Deployment unique identifier expressed as UUID or name.
  • deployment_data DeploymentData

Output

• output Deployment

projects_deployments_deploy

Deploy an existing model

illumidesk.projects_deployments_deploy({
  "project": "",
  "namespace": "",
  "deployment": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • deployment required string: Deployment unique identifier expressed as UUID or name.

Output

Output schema unknown

projects_project_files_list

Get project files

illumidesk.projects_project_files_list({
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • project required string: Unique identifier for project file expressed as UUID or name.
  • namespace required string: User or team name.
  • limit string: Limit when getting project file list.
  • offset string: Offset when getting project file list.
  • ordering string: Ordering of list values when getting project file list.
  • filename string: Exact file name, relative to the project root. If no such file is found, an empty list will be returned.
  • content string: Determines whether or not content is returned as base64. Defaults to false.

Output

• output array
  • items ProjectFile

projects_project_files_create

Create project files

illumidesk.projects_project_files_create({
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • project required string: Project unique identifier.
  • namespace required string: User or team name.
  • file string, object: File to send, to create new file. This parameter is only used with form data and may include multiple files.
    • content string
    • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
    • contentType string
    • filename string
  • base64_data string: Fila data, represented as base64.
  • name string: File name. May include path when creating file with base64 field.
  • path string: File path. Defaults to (/).

Output

• output ProjectFile

projects_project_files_delete

Delete a project file

illumidesk.projects_project_files_delete({
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • project required string: Project unique identifer.
  • namespace required string: User or team name.
  • id required string: File unique identifier.

Output

Output schema unknown

projects_project_files_read

Get a project file

illumidesk.projects_project_files_read({
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • project required string: Project unique identifer.
  • namespace required string: User or team name.
  • id required string: File unique identifier.
  • content string: Determines whether or not content is returned as base64. Defaults to false.

Output

• output ProjectFile

projects_project_files_update

Update a project file

illumidesk.projects_project_files_update({
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • project required string: Project unique identifer.
  • namespace required string: User or team name.
  • id required string: File unique identifier.
  • file string, object: File to send, to create new file. This parameter is only used with form data and may include multiple files.
    • content string
    • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
    • contentType string
    • filename string
  • base64_data string: Fila data, represented as base64.
  • name string: File name. May include path when creating file with base64 field.
  • path string: File path. Defaults to (/).

Output

• output ProjectFile

projects_project_files_replace

Replace a project file

illumidesk.projects_project_files_replace({
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • project required string: Project unique identifer.
  • namespace required string: User or team name.
  • id required string: File unique identifier.
  • file string, object: File to send, to create new file. This parameter is only used with form data and may include multiple files.
    • content string
    • encoding string (values: ascii, utf8, utf16le, base64, binary, hex)
    • contentType string
    • filename string
  • base64_data string: Fila data, represented as base64.
  • name string: File name. May include path when creating file with base64 field.
  • path string: File path. Defaults to (/).

Output

• output ProjectFile

projects_servers_list

Retrieve servers

illumidesk.projects_servers_list({
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • limit string: Limit results when getting server list.
  • offset string: Offset results when getting server list.
  • name string: Server name.
  • ordering string: Ordering option when getting server list.

Output

• output array
  • items Server

projects_servers_create

Create a new server

illumidesk.projects_servers_create({
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • project required string: Project unique identifer expressed as UUID or name.
  • namespace required string: User or team name.
  • server_data ServerData

Output

• output Server

projects_servers_statuses

Retrieve server statuses

illumidesk.projects_servers_statuses({
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.

Output

• output array
  • items ServerStatus

projects_servers_delete

Delete a server

illumidesk.projects_servers_delete({
  "project": "",
  "namespace": "",
  "server": ""
}, context)

Input

• input object
  • project required string: Project unique identifier.
  • namespace required string: User or team name.
  • server required string: User unique identifier.

Output

Output schema unknown

projects_servers_read

Retrieve a server

illumidesk.projects_servers_read({
  "project": "",
  "namespace": "",
  "server": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • server required string: Server unique identifier expressed as UUID or name.

Output

• output Server

projects_servers_update

Update a server

illumidesk.projects_servers_update({
  "project": "",
  "namespace": "",
  "server": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • server required string: Server unique identifier expressed as UUID or name.
  • server_data ServerData

Output

• output Server

projects_servers_replace

Replace a server

illumidesk.projects_servers_replace({
  "project": "",
  "namespace": "",
  "server": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • server required string: Server unique identifier expressed as UUID or name.
  • server_data ServerData

Output

• output Server

v1.namespace.projects.project.servers.server.api_key.get

Get server API key

illumidesk.v1.namespace.projects.project.servers.server.api_key.get({
  "project": "",
  "namespace": "",
  "server": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • server required string: Server unique identifier expressed as UUID or name.

Output

• output JWT

projects_servers_auth

Server api key validation

illumidesk.projects_servers_auth({
  "project": "",
  "namespace": "",
  "server": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • server required string: Server unique identifier expressed as UUID or name.

Output

Output schema unknown

v1.namespace.projects.project.servers.server.run_stats.post

Create a new server's run statistics

illumidesk.v1.namespace.projects.project.servers.server.run_stats.post({
  "server": "",
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • serverrunstats_data ServerRunStatisticsData

Output

• output ServerRunStatistics

v1.namespace.projects.project.servers.server.run_stats.id.delete

Delete a server's statistics

illumidesk.v1.namespace.projects.project.servers.server.run_stats.id.delete({
  "server": "",
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • id required string: Server run statistics unique identifier expressed as UUID.

Output

Output schema unknown

v1.namespace.projects.project.servers.server.run_stats.id.get

Retrieve statistics for a server

illumidesk.v1.namespace.projects.project.servers.server.run_stats.id.get({
  "server": "",
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • id required string: Run statistics unique identifier expressed as UUID.

Output

• output ServerRunStatistics

v1.namespace.projects.project.servers.server.run_stats.id.patch

Update a server's statistics

illumidesk.v1.namespace.projects.project.servers.server.run_stats.id.patch({
  "server": "",
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • id required string: Server run statistics unique identifier expressed as UUID.
  • serverrunstats_data ServerRunStatisticsData

Output

• output ServerRunStatistics

v1.namespace.projects.project.servers.server.run_stats.id.put

Replace a server's statistics

illumidesk.v1.namespace.projects.project.servers.server.run_stats.id.put({
  "server": "",
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • id required string: Server run statistics expressed as UUID.
  • serverrunstats_data ServerRunStatisticsData

Output

• output ServerRunStatistics

v1.namespace.projects.project.servers.server.ssh_tunnels.get

Get SSH Tunnels associated to a server

illumidesk.v1.namespace.projects.project.servers.server.ssh_tunnels.get({
  "server": "",
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • limit string: Limit retrieved items.
  • offset string: Offset retrieved items.
  • ordering string: Order retrieved items.

Output

• output array
  • items SshTunnel

v1.namespace.projects.project.servers.server.ssh_tunnels.post

Create SSH Tunnel associated to a server

illumidesk.v1.namespace.projects.project.servers.server.ssh_tunnels.post({
  "server": "",
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • sshtunnel_data SshTunnelData

Output

• output SshTunnel

v1.namespace.projects.project.servers.server.ssh_tunnels.tunnel.delete

Delete an SSH Tunnel associated to a server

illumidesk.v1.namespace.projects.project.servers.server.ssh_tunnels.tunnel.delete({
  "server": "",
  "project": "",
  "namespace": "",
  "tunnel": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • tunnel required string: SSH tunnel unique identifier expressed as UUID or name.

Output

Output schema unknown

v1.namespace.projects.project.servers.server.ssh_tunnels.tunnel.get

Get an SSH Tunnel associated to a server

illumidesk.v1.namespace.projects.project.servers.server.ssh_tunnels.tunnel.get({
  "server": "",
  "project": "",
  "namespace": "",
  "tunnel": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • tunnel required string: SSH tunnel unique identifier expressed as UUID or name.

Output

• output SshTunnel

v1.namespace.projects.project.servers.server.ssh_tunnels.tunnel.patch

Update an SSH Tunnel associated to a server

illumidesk.v1.namespace.projects.project.servers.server.ssh_tunnels.tunnel.patch({
  "server": "",
  "project": "",
  "namespace": "",
  "tunnel": ""
}, context)

Input

• input object
  • server required string
  • project required string
  • namespace required string: User or team name.
  • tunnel required string
  • sshtunnel_data SshTunnelData

Output

• output SshTunnel

v1.namespace.projects.project.servers.server.ssh_tunnels.tunnel.put

Replace SSH Tunnel associated to a server

illumidesk.v1.namespace.projects.project.servers.server.ssh_tunnels.tunnel.put({
  "server": "",
  "project": "",
  "namespace": "",
  "tunnel": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • tunnel required string: SSH tunnel unique identifier expressed as UUID or name.
  • sshtunnel_data SshTunnelData

Output

• output SshTunnel

projects_servers_start

Start a server

illumidesk.projects_servers_start({
  "project": "",
  "namespace": "",
  "server": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • server required string: Server unique identifier expressed as UUID or name.

Output

Output schema unknown

projects_servers_stats_delete

Delete a server's statistics

illumidesk.projects_servers_stats_delete({
  "server": "",
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • id required string: Stats unique identifier expressed as UUID.

Output

Output schema unknown

projects_servers_stats_read

Retrieve a server's statistics

illumidesk.projects_servers_stats_read({
  "server": "",
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • id required string: Server statistics unique identifier expressed as UUID.

Output

• output ServerStatistics

projects_servers_stats_update

Update a server's statistics

illumidesk.projects_servers_stats_update({
  "server": "",
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • id required string: Server statistics unique identifier expressed as UUID.
  • serverstats_data ServerStatisticsData

Output

• output ServerStatistics

projects_servers_stats_replace

Replace a server's statistics

illumidesk.projects_servers_stats_replace({
  "server": "",
  "project": "",
  "namespace": "",
  "id": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • id required string: Server statistics unique identifier expressed as UUID.
  • serverstats_data ServerStatisticsData

Output

• output ServerStatistics

projects_servers_stop

Stop a server

illumidesk.projects_servers_stop({
  "project": "",
  "namespace": "",
  "server": ""
}, context)

Input

• input object
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • server required string: Server unique identifier expressed as UUID or name.

Output

Output schema unknown

service_trigger_list

Retrieve server triggers

illumidesk.service_trigger_list({
  "server": "",
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • name string: Trigger name.
  • limit string: Limit when getting triggers.
  • offset string: Offset when getting triggers.
  • ordering string: Ordering when getting triggers.

Output

• output array
  • items ServerAction

service_trigger_create

Create a new server trigger

illumidesk.service_trigger_create({
  "server": "",
  "project": "",
  "namespace": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • server_action ServerActionData

Output

• output ServerAction

service_trigger_delete

Delete a server trigger

illumidesk.service_trigger_delete({
  "server": "",
  "project": "",
  "namespace": "",
  "trigger": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • trigger required string: Trigger identifier expressed as UUID or name.

Output

Output schema unknown

service_trigger_read

Get a server trigger

illumidesk.service_trigger_read({
  "server": "",
  "project": "",
  "namespace": "",
  "trigger": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • trigger required string: Trigger unique identifier.

Output

• output ServerAction

service_trigger_update

Update a server trigger

illumidesk.service_trigger_update({
  "server": "",
  "project": "",
  "namespace": "",
  "trigger": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • trigger required string: Trigger identifier expressed as UUID or name.
  • server_action ServerActionData

Output

• output ServerAction

service_trigger_replace

Replace a server trigger

illumidesk.service_trigger_replace({
  "server": "",
  "project": "",
  "namespace": "",
  "trigger": ""
}, context)

Input

• input object
  • server required string: Server unique identifier expressed as UUID or name.
  • project required string: Project unique identifier expressed as UUID or name.
  • namespace required string: User or team name.
  • trigger required string: Trigger unique identifier.
  • server_action ServerActionData

Output

• output ServerAction

search

Get a search results

illumidesk.search({
  "namespace": "",
  "q": ""
}, context)

Input

• input object
  • namespace required string: User or team name.
  • q required string: Search string.
  • type string (values: users, projects, servers): Limit results to specific types.
  • limit string: Limit data when getting items.
  • offset string: Offset data when getting items.

Output

• output array
  • items Search

Definitions

Action

• Action object
  • action required string: Action name.
  • action_name string: Action name.
  • can_be_cancelled boolean: Can action be cancelled, or not.
  • can_be_retried boolean: May action be retried, or not.
  • end_date string: Action needs to end before a certain date and time.
  • id string: Action unique identifier, expressed as UUID.
  • ip string: IP address that action is related to.
  • is_user_action boolean: Is the action related to a user, or not.
  • method required string: Action method.
  • object string: Action object.
  • path string: Action path.
  • payload object: Object action payload.
  • resource_uri string: Resource URI.
  • start_date string: Action date and time start.
  • state required string: Action state.
  • user string: User that action is assigned to.
  • user_agent required string: User agent that action is related to.

Application

• Application object
  • authorization_grant_type string (values: authorization-code, implicit, password, client-credentials): OAuth2 authorization grant type
  • client_id string: OAuth2 client id
  • client_secret string: OAuth2 client secret
  • client_type string (values: confidential, public): OAuth2 client type
  • id string: Application unique identifier, expressed as UUID.
  • name string: Appl