Endpoint
/api/v2/tenants/{tenantId}/policies/discovery/{discoveryId}
Path Parameters
tenantId
string

discoveryId
string

Responses

OK

actualEntity
string

allowedMethods
array

cookies
object

entity
string

headers
object

length
integer

links
array

metadata
object

status
integer

statusInfo
object

statusInfo.family
statusInfo.reasonPhrase
statusInfo.statusCode
stringHeaders
object

{
  "actualEntity": "Removed discovery profile with id  : 54",
  "allowedMethods": [],
  "cookies": {},
  "entity": "Removed discovery profile with id  : 54",
  "headers": {},
  "length": -1,
  "links": [],
  "metadata": {},
  "status": 200,
  "statusInfo": {
    "family": "SUCCESSFUL",
    "reasonPhrase": "OK",
    "statusCode": 200
  },
  "stringHeaders": {}
}
Endpoint
/api/v2/tenants/{tenantId}/policies/discovery/{discoveryId}
Path Parameters
tenantId
string

discoveryId
string

Responses

OK

credential
object

credential.AWSType
AWS
credential.AccessKey
AWS
credential.AccountNumber
AWS
credential.AssumeRoleARN
AWS
credential.AzureType
Azure
credential.ClientID
Azure
credential.ExternalId
AWS
credential.KeystorePassword
Azure
credential.ManagementCertificate
Azure
credential.ManagementCertificatePassPhrase
Google
credential.Name
credential.ProjectId
Google
credential.Regions
AWS
credential.SecretKey
Azure
credential.SecurityKey
AWS
credential.ServiceAccountEmail
Google
credential.ServiceAccountManagementCertificate
Google
credential.SubscriptionId
Azure
credential.TenantId
Azure
credential.accountId
credential.credentialName
credential.credentialType
credentialSet
string

Credential set to be assigned to the discovery profile.

id
integer

installedIntegrationId
string

name
string

Discovery profile name.

policy
object

Set of functions formed together as a policy and attached with the discovery profile. Rules to filter the resources to which the discovery profile is attached

policy.actions
policy.entityType
policy.executionOrder
policy.id
policy.matchType
policy.name
policy.rules
policy.uid
scanNow
boolean

schedule
object

(Optional) Define the discovery time of resources:

schedule.pattern
Pattern of the schedule. Example: If pattern type is WEEKLY, then pattern is MON, WED.
schedule.patternType
Discovery schedule pattern type. Example: HOURLY, DAILY, WEEKLY, MONTHLY, MINUTES.
schedule.startTime
Define start time of discovery.
{
  "credential": {
    "accountId": "290642135901",
    "credentialName": "AWS Integration"
  },
  "credentialSet": "AWS Integration",
  "id": 110,
  "name": "AWS discovery profile",
  "policy": {
    "actions": [
      {
        "action": "MANAGE DEVICE",
        "items": []
      },
      {
        "action": "STREAM AWS ALERTS",
        "items": [
          {
            "instances": {},
            "item": "https://cloudwatch-url",
            "parameters": {}
          }
        ]
      }
    ],
    "entityType": "ALL",
    "executionOrder": 0,
    "id": 136,
    "matchType": "ANY",
    "name": "AWS discovery profile",
    "rules": [
      {
        "filterType": "ANY_CLOUD_RESOURCE"
      }
    ]
  },
  "schedule": {
    "pattern": "2",
    "patternType": "HOURLY",
    "startTime": "02:00:00"
  }
}
{
  "credential": {
    "accountId": "9ee6993f-a036-4118-9eab-c66d9fda1ef3",
    "credentialName": "Azure Credentials"
  },
  "credentialSet": "Azure Credentials",
  "id": 102183,
  "name": "Azure",
  "policy": {
    "actions": [
      {
        "action": "MANAGE DEVICE",
        "items": []
      },
      {
        "action": "ASSIGN GATEWAY MANAGEMENT PROFILE",
        "items": [
          {
            "instances": {},
            "item": "24422",
            "parameters": {}
          }
        ]
      },
      {
        "action": "INSTALL OPSRAMP AGENT",
        "items": [
          {
            "instances": {},
            "item": "169743",
            "parameters": {}
          }
        ]
      },
      {
        "action": "SELECT GATEWAY",
        "items": [
          {
            "instances": {},
            "item": "24422",
            "parameters": {}
          }
        ]
      }
    ],
    "executionOrder": 0,
    "id": 39733,
    "matchType": "ANY",
    "name": "Azure",
    "resourceType": "ALL",
    "rules": [
      {
        "filterType": "ANY_DEVICE"
      },
      {
        "filterType": "EBS"
      },
      {
        "filterType": "WEBSITE"
      },
      {
        "filterType": "SQL_SERVER"
      },
      {
        "filterType": "SQL_DATABASE"
      },
      {
        "filterType": "RESOURCE_GROUP"
      },
      {
        "filterType": "REDIS_CACHE"
      },
      {
        "filterType": "DOCUMENT_DB"
      }
    ]
  },
  "schedule": {
    "pattern": "30",
    "patternType": "MINUTES",
    "startTime": "00:30:00"
  }
}
{
  "credential": {
    "accountId": "gce-integration",
    "credentialName": "Google GOOGLEIntegration"
  },
  "credentialSet": "Google GOOGLEIntegration",
  "id": 963,
  "installedIntegrationId": "INTG-8abf482f-1423-18b7-4578-be47080aaa72",
  "name": "Google",
  "policy": {
    "actions": [
      {
        "action": "MANAGE DEVICE",
        "items": []
      }
    ],
    "id": 822,
    "matchType": "ANY",
    "name": "GOOGLE",
    "resourceType": "ALL",
    "rules": [
      {
        "filterType": "ANY_CLOUD_RESOURCE",
        "id": 18821
      }
    ]
  },
  "schedule": {
    "pattern": "2",
    "patternType": "HOURLY",
    "startTime": "02:00:00"
  }
}