Manage Resources

Gets resource information, update resource details, and delete a resource using a resource ID.

Gets information and optional device details for a specific resource.

Path Parameters

  • resourceIdstringrequired

    Resource uuid of the managed resource

  • clientIdstringrequired

    Describes the clientId of the tenant

Responses

  • idstringrequired

  • hostNamestring

  • ipAddressstring

  • identitystring

  • createdDatestring

  • updatedDatestring

  • typestring

  • statestring

  • sourcestring

  • statusstring

  • aliasNamestring

  • tagsarray

  • namestring

  • resourceNamestring

  • consolesarray of strings

  • propertiesobject

  • clientUniqueIdstring

  • resourceTypestring

  • frequencynumber

  • pausedboolean

  • deletedboolean

  • validateSSLboolean

  • portnumber

  • encryptedboolean

  • timeoutnumber

  • tsnumber

  • clientIdnumber

  • locationOffsetnumber

  • totalLocationsnumber

  • receiverHostPortnumber

  • topologyEnabledboolean

  • deviceboolean

  • excludeIndexingboolean

  • cloudInstanceboolean

  • saIdnumber

  • checkTypestring

    Enum:
    HTTPHTTPSDNSIMAPPINGRTTPOP3SCRIPTSMTPSSLTCPUDPFTP
  • hoststring

  • locationUuidsarray of strings

  • credentialobject

  • credentialsarray

  • managementProfileobjectrequired

  • componentsarray of strings

  • biosobject

  • cpusarray

  • generalInfoobject

  • installedAppobject

  • metricTypesarray

  • networkCardDetailsarray

  • discoveryProfileobject

  • locationobject

  • appRolesarray

  • agentInstalledboolean

    Agent installed resource or not.

  • agentStatusstring

    Agent live status.

    Enum:
    OFFLINEONLINE
  • agentLastConnectedTimestring

    Agent's last connected timestamp based on the resource site timezone.

Loading Examples...

Updates the details of a resource.

Path Parameters

  • resourceIdstringrequired

    Resource uuid of the managed resource

  • clientIdstringrequired

    Describes the clientId of the tenant

Request Body

application/json

  • aliasNamestring

    Another name of a resource.

  • alternateIPstring

    Gateway uses alternate IP to discover a resource when populated.

  • extResourceIdstring

    Attach third-party integration ID.

  • descriptionstring

    Description for the resource.

  • managementProfilestring

    Name of management profile of a resource that is managed.

  • resourceNetworkInterfacearray

    Details of network interface.

  • logicalDiskDrivesarray

  • oobInterfaceCardsarray

    OOB interface card details.

  • resourceTypestringrequired

    Type of resource. Example: server, SYNTHETICS

  • systemUIDstring

    Unique ID of system.

  • serialNumberstring

    Serial number of resource.

  • providerTypestring

    Type of provider.

  • providerUIDstring

    Unique ID of provider.

  • checkTypestring

    Category type for Synthetics. Example: http, https, ftp, and so on.

  • credentialobject

    (Optional) Credentials for Synthetics.

  • sslCertPathstring

    (Optional) Path of the SSL Certificate

  • SslCertKeyPathstring

    (Optional) Path of the SSL certificate key.

  • downloadFilePathstring

    (Optional) Path where you want to download the file.

  • scriptstring

Loading Examples...

Responses

200OK

Deletes a resource using the resource ID.

Path Parameters

  • resourceIdstringrequired

    Resource uuid of the managed resource

  • clientIdstringrequired

    Describes the clientId of the tenant

Responses

200OK