Operations at agents/
This page describes the service operations at this endpoint.
| URI | Method | Description |
|---|---|---|
| agents/ | GET | Gets a list of all agents known to the core. |
| agents//metadata/credentials | POST | Gets credentials which used for metadata retrival for set of agents with specified Ids |
| agents//metadata/refresh | POST | Forces metadata refresh for several agents with specified Ids |
| agents//metadata/setcredentials | POST | Sets credentials which used for metadata retrival for specified collection of agents |
| agents/{agentId}/{repositoryId}/info | GET | Gets the information about an agent protected by Replay. |
| agents/{agentId}/cachedmetadata | GET | Gets cached metadata for an agent protected by Replay. |
| agents/{agentId}/cachedmetadata/summary | GET | Gets cached summary metadata for an agent protected by Replay. |
| agents/{agentId}/cachedwriters | GET | Gets cached information about VSS writers installed on the agent. |
| agents/{agentId}/changeDisplayName/{newDisplayName} | POST | Changes the display name used by the GUI for a given Agent. |
| agents/{agentId}/changeHostName/{newHostName} | POST | Changes the host name used in connecting to a given Agent. |
| agents/{agentId}/changeOperatingSystem/{operatingSystemFamily} | POST | Sets specified OS Version (from the 'OperatingSystemFamily' enum) for the Hyper-V host-based agent. Other types are not supported. |
| agents/{agentId}/changeRepository/{repositoryId} | POST | Assigns a repository to an agent which was added to replication. |
| agents/{agentId}/delete | POST | Deletes an agent from the core, optionally deletes the agent's recovery points and disables the agent's volumes as well. |
| agents/{agentId}/descriptor | POST | Changes the descriptor used for an existing agent, so the core will use a new caller-specified URI and credentials. |
| agents/{agentId}/details | GET | Gets all information required to display the Agent Details page in the GUI. |
| agents/{agentId}/excludedwriters | GET | Gets information about VSS writers that are excluded during transfer. |
| agents/{agentId}/info | GET | Gets the information about an agent protected by Replay. |
| agents/{agentId}/isChangingRepositoryAllowed | POST | Verify if changing repository is allowed for current agent |
| agents/{agentId}/metadata | GET | Gets the latest metadata for an agent protected by Replay. |
| agents/{agentId}/metadata/credentials | GET | Gets credentials which used for metadata retrival for agent with specified Id |
| agents/{agentId}/metadata/credentials | POST | Sets credentials which used for metadata retrival for agent with specified Id |
| agents/{agentId}/metadata/credentials/default | POST | Sets the OS login credentials for metadata retrieval for the agent with the specified ID. |
| agents/{agentId}/metadata/credentials/exchange | POST | Sets the Exchange credentials for metadata retrieval for the agent with the specified ID. |
| agents/{agentId}/metadata/credentials/sql | POST | Sets the SQL Server credentials for metadata retrieval for the agent with the specified ID. |
| agents/{agentId}/metadata/refresh | POST | Forces metadata refresh for agent with specified Id |
| agents/{agentId}/metadata/summary | GET | Gets latest summary metadata for an agent protected by Core. |
| agents/{agentId}/OracleMetadata/refresh | POST | Forces Oracle metadata refresh for agent with specified Id |
| agents/{agentId}/port | POST | Changes port used in connecting to a given Agent. |
| agents/{agentId}/rpmetadata/summary | GET | Gets summary metadata for an agent from last recovery point. |
| agents/{agentId}/setSchedule | POST | Sets or updates schedule for volumes |
| agents/{agentId}/setstorageConfiguration | POST | Restores storage configuration if it was determined for agent |
| agents/{agentId}/summaryInfo | GET | Gets summary agent information including summary metadata, recent associated alerts and recent recovery points. |
| agents/{agentId}/writers | GET | Gets detailed information about VSS writers installed on the agent. |
| agents/{repositoryId}/{agentId}/writers | GET | Gets metadata for agent in mounted backup repositository. |
| agents/agentInfos | POST | Gets a list of agents info for specific agents |
| agents/agentos | POST | Gets operating system details for the agent from the recovery point if ID is specified or from the metadata. |
| agents/associate | POST | Associates agents with the specified hypervisor. |
| agents/count | GET | Get the total number of machines handled by the Core, including protected agents, agentless, recovery points only and replicated machines. |
| agents/delete | POST | Deletes agents from the core, optionally deletes the agent's recovery points and disables the agent's volumes as well. |
| agents/descriptors | GET | Gets simply information about the Agent. |
| agents/details/bulk?startIndex={startIndex}&count={count} | GET | Gets details for a range of agents. |
| agents/dissociate | POST | Dissociate agents from hypervisor. |
| agents/find/{agentId} | GET | Finds the information about an agent protected by Replay if it exists. |
| agents/findAgentsForAssociationWithHypervisor/{hypervisorAgentId} | GET | Finds virtual machines hosted by the hypervisor that are protected by the Core with the agent. |
| agents/findByName/{nameOrIpAddress} | GET | Finds an agent by its display name, host name or IP address. |
| agents/findHypervisonForAssociationWithAgent/{AgentId} | GET | Finds hypervisor for association with agent. |
| agents/infosummaries | GET | Gets a list of info summary data contracts for each (protected, replicated and replay only) agent. This is an extremely lightweight method that does not perform any metadata-related REST calls and provides very limited information |
| agents/isAgentAlreadyProtectedWithAnotherType | POST | Verifies if agent already protected with another type |
| agents/new | POST | Adds an agent that isn't currently protected, pairs with the agent and writes it's protection configuration. |
| agents/newagents | POST | Adds the specified agents that are not currently protected. The agents are paired with and their protection configuration is written |
| agents/newWithValidGroups | POST | Adds an agent that isn't currently protected, pairs with the agent and writes it's protection configuration, validates protection groups. |
| agents/pairing/repair | POST | Attempts to re-establish pairing with an agent already protected by the core, possibly using new credentials. |
| agents/pairing/repairAgent | POST | Repair agent previously protected by this core |
| agents/protected | GET | Gets a list of protected agents known to the core. |
| agents/protected/paged?agentsPerPage={agentsPerPage}&pageNumber={pageNumber} | PUT | Gets a paged list of protected agents known to the core. |
| agents/protectedAgentsCount | POST | Get protected agents number. |
| agents/protectedByIds | POST | Gets a list of protected agents known to the core by ids. |
| agents/protectedSummaries | GET | Gets a list of protected agents summaries known to the core. |
| agents/query/agentFeatures | PUT | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the agent's features. |
| agents/query/availableGroups | PUT | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the list of volumes which are available for protection, grouped to reflect protection dependencies. It is possible that an agent and a core are installed on the same machine so a resulting list would not contain volumes which contain core repository data or metadata directories. For regular cases this list would be identical to a list of volumes returned in metadata. |
| agents/query/availablevolumes | PUT | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the list of volumes which are available for protection. It is possible that an agent and a core are installed on the same machine so a resulting list would not contain volumes which contain core repository data or metadata directories. For regular cases this list would be identical to a list of volumes returned in metadata. |
| agents/query/checkpairing | PUT | Connects to an agent specified in the descriptor (probably not currently protected by this core) and checks if the agent is paired to this core or any core at all. |
| agents/query/metadata | PUT | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the agent's metadata. |
| agents/query/pairing | PUT | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the agent's pairing information. |
| agents/query/summarymetadata | PUT | Connects to an agent specified in the descriptor (probably not currently protected by this core) and requests the agent's summary metadata. |
| agents/query/validateVirtualMachine | PUT | Connects to an agent specified in the descriptor (probably not currently protected by this core) and validates virtual machine for pairing. |
| agents/recoveryPointsOnly | GET | Gets a list of recovery points' only agents |
| agents/recoveryPointsOnly/paged?agentsPerPage={agentsPerPage}&pageNumber={pageNumber} | PUT | Gets a paged list of recovery points' only agents |
| agents/recoveryPointsOnlySummaries | GET | Gets a list of recovery points' only agents summaries |
| agents/replicated | GET | Gets a list of replicated agents known to the core. |
| agents/replicated/paged?agentsPerPage={agentsPerPage}&pageNumber={pageNumber} | PUT | Gets a paged list of replicated agents known to the core. |
| agents/replicatedAgentsCount | GET | Get replicated agents number. |
| agents/replicatedSummaries | GET | Gets a list of replicated agents summaries known to the core. |
| agents/rpOnlyAgentsCount | GET | Get recovery points only agents number. |
| agents/updateAgentCredentialsForEsxServer | POST | Update agent credentials for ESXi server and its virtual machines. |
| agents/updateAgentCredentialsForHyperVServer | POST | Update agent credentials for Hyper-V server and its virtual machines. |
| agents/validateAgentCreationParameters | POST | Validate agent creation parameters. |
| agents/validateAgentCreationParametersForDeploy | POST | Validate agent creation parameters for deploy. |
| agents/validateAgentProtectionAbility | POST | Verify if the Agent can be protected |
| agents/validateSelfProtectRestriction | POST | Validates self protection restriction |
| agents/verifyClusterAddress | POST | Verify if provided address is cluster |
| agents/verifyConnection/?useNtlm={useNtlm} | POST | Trying to connect to agent and return its Id. |
| agents/verifyVolumesConflictState | POST | Verifies whether volumes, selected for protection are not in a conflict state with any of the specified repository paths on agent environment |