NagentArtefacts
Dev & Technology
Enterprise and White Glove
Company
Serveravatar connects to a Nagent workspace with an API key. Once it is connected, agents can call 17 Serveravatar actions, such as "Get organization details", "List Applications" and "List Backups". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Serveravatar, with input parameters and output schema.
SERVERAVATAR_DESTROY_BACKUPSTool to delete one or more backups from the cloud storage provider. Use when you need to remove specific backups by their IDs from an organization.
Input parameters
Collection of backup identifiers to be removed. Provide an array of backup IDs that you want to delete from the cloud storage provider.
Organization ID where the backups are located. This identifies the organization context for the backup deletion operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_GET_ORGANIZATIONTool to retrieve details of a specific organization by ID. Use when you need to fetch information about an organization.
Input parameters
Organization ID to retrieve details for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_APPLICATIONSTool to list applications for a specific organization in ServerAvatar. Use when you need to retrieve all applications associated with an organization ID.
Input parameters
The organization ID to list applications for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_BACKUPSTool to list all backups in a ServerAvatar organization. Use when you need to retrieve backup information including status, size, and expiration dates.
Input parameters
Page number to retrieve. Default: 1.
Organization ID to list backups for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_BACKUPS_ARCHIVETool to list archived backups for an organization by type. Use when you need to retrieve archived backups filtered by type (filesystem, database, or application).
Input parameters
Page number for pagination. Defaults to 1 if not specified.
Type of backup to list: filesystem, database, or application.
Organization ID to list archived backups for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_BACKUPS_DELETED_SERVERTool to get list of deleted servers with available backups. Use when you need to retrieve information about servers that have been deleted but still have backup data in the archive.
Input parameters
Page number for pagination. Defaults to 1 if not specified.
Organization ID to retrieve deleted server backups for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_BACKUPS_PRESETSTool to retrieve backup preset schedules and retention periods for a server. Use when you need to view available backup scheduling options and retention period configurations.
Input parameters
Server ID to retrieve backup presets for.
Organization ID to retrieve backup presets for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_CLOUD_SERVER_PROVIDERSTool to list connected cloud server provider accounts for an organization. Use when you need to retrieve all connected provider accounts like DigitalOcean, Vultr, Linode, Hetzner, or AWS Lightsail.
Input parameters
Search by email address associated with the provider account
Filter by provider type (e.g., lightsail, digitalocean, vultr, linode, hetzner)
Enable pagination by setting to 1. When enabled, returns paginated response with metadata. When omitted, returns simple array.
Organization ID for which to list cloud server providers
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_CLOUD_STORAGE_PROVIDERSTool to list all configured cloud storage providers for an organization. Use when you need to retrieve available storage provider configurations for backups or file storage.
Input parameters
The organization ID to list cloud storage providers for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_CRONJOBS_PRESETSTool to retrieve available cronjob presets for a server. Use when you need to get standard cron expressions for scheduling tasks at various intervals.
Input parameters
Server identifier to retrieve cronjob presets for.
Organization identifier for the ServerAvatar account.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_DATABASESTool to list databases for a given organization. Use when you need to retrieve all databases or filter by name.
Input parameters
Filter results by database name
Enable pagination (set to 1 to enable)
The organization identifier
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_GIT_PROVIDERSTool to list git providers for a specific organization. Use when you need to retrieve all git providers configured for an organization.
Input parameters
The organization ID to list git providers for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_MEMBERSTool to list members of a specific organization in ServerAvatar. Use when you need to retrieve all members associated with an organization ID, including their roles and user details.
Input parameters
Pagination page number for fetching specific page of results
Search filter to find specific members by name or email
The organization ID to list members for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_ORGANIZATIONSTool to list all organizations associated with the authenticated user account. Use when you need to retrieve all organizations the user has access to.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_SERVERSTool to list all servers in an organization with pagination support. Use when you need to retrieve servers for a specific organization.
Input parameters
Page number for pagination. If not provided, returns first page.
Organization ID to list servers for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_TIMEZONESTool to retrieve the list of available timezones with their UTC offsets. Use when you need to get timezone options for creating or configuring applications.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
SERVERAVATAR_LIST_WORDPRESS_LANGUAGESTool to retrieve all available WordPress languages. Use when you need to get the list of supported languages for WordPress installation or configuration.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 17 Serveravatar actions on Nagent, including "Get organization details", "List Applications" and "List Backups". Get organization details: Retrieve details of a specific organization by ID. Each action is listed on this page with its input parameters and its output.
Serveravatar connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Get organization details takes 1 required input: organization. It returns data, error and successful.