Jump to

• Request
• Response

Update an Inclusion Profile

put

/api/discovery/Includes/{id}

Updates the properties of the inclusion profile that matches the specified ID.

Request

Path Parameters

• id(required): integer
  The discovery profile ID.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• BaseDN: string
  LDAP base domain name

  Example: DC=localdomain,DC=local
• CDPSeeds: string
  CDP Seeds (e.g. 10.10.10.1,hostname,172.16.10.1)

  Example: oracle.doceng.json.BetterJsonNull@654db80b
• CIDR: string
  CIDR determines type of range expansion Allowed Values: - 1 => Glob expansion (e.g. 10.*.0-9.1,2,3,4) - 2 => CIDR expansion (e.g. 172.16.10.0/24)

  Example: oracle.doceng.json.BetterJsonNull@336070ab
• DeviceZoneID: integer
  Unique identifier for Device Zone.

  Example: 1
• Hops: integer
  Number of iterations for CDP discovery

  Example: oracle.doceng.json.BetterJsonNull@9de1b85
• IPRange: string
  IP Range (e.g. 10.*.0-9.1,2,3,4 for glob expansion; 172.16.10.0/24 for CIDR expansion)

  Example: 10.*.0-9.1
• ProfileName: string
  Profile Name

  Example: Example Active Directory Scan
• ProfileStatusID: integer
  Profile Status ID Allowed Values: 0 => Disabled 1 => Enabled

  Example: 0
• ProfileTypeID: integer
  Unique identifier for Profile Type. Allowed Values: - 1 => Ping Scan - 2 => Seed Scan - 3 => LDAP Scan - 4 => CDP Scan If ProfileTypeID = 1, it updates IPRange, CID parameters if specified. If ProfileTypeID = 2, it updates Seeds parameter if specified. If ProfileTypeID = 3, it updates ServerName, ServerPort, BaseDN, UserDN, UserPass, Query parameters if specified. If ProfileTypeID = 4, it updates CDPSeeds, Hops parameters if specified.

  Example: 3
• Query: string
  LDAP query text to produce server names

  Example: (objectClass=computer)
• Seeds: string
  Seeds (e.g. 10.10.10.1,hostname,172.16.10.1)

  Example: oracle.doceng.json.BetterJsonNull@3d3b4e09
• ServerName: string
  LDAP server fqdn host or IP Address

  Example: ldap.localdomain.local
• ServerPort: integer
  LDAP server port (tcp only)

  Example: 389
• UserDN: string
  LDAP base user name

  Example: monolith@localhost
• UserPass: string
  LDAP base user password

  Example: password

{
    "type":"object",
    "properties":{
        "ProfileName":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/ProfileName"
        },
        "DeviceZoneID":{
            "description":"Unique identifier for Device Zone.",
            "type":"integer",
            "example":"1"
        },
        "ProfileStatusID":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/ProfileStatusID"
        },
        "ProfileTypeID":{
            "description":"Unique identifier for Profile Type.\n\nAllowed Values:\n- 1 => Ping Scan\n- 2 => Seed Scan\n- 3 => LDAP Scan\n- 4 => CDP Scan\n\nIf ProfileTypeID = 1, it updates IPRange, CID parameters if specified.\n\nIf ProfileTypeID = 2, it updates Seeds parameter if specified.\n\nIf ProfileTypeID = 3, it updates ServerName, ServerPort, BaseDN, UserDN, UserPass, Query parameters if specified.\n\nIf ProfileTypeID = 4, it updates CDPSeeds, Hops parameters if specified.",
            "type":"integer",
            "example":"3"
        },
        "IPRange":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/IPRange"
        },
        "CIDR":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/CIDR"
        },
        "Seeds":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/Seeds"
        },
        "CDPSeeds":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/CDPSeeds"
        },
        "Query":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/Query"
        },
        "Hops":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/Hops"
        },
        "ServerName":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/ServerName"
        },
        "ServerPort":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/ServerPort"
        },
        "BaseDN":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/BaseDN"
        },
        "UserDN":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/UserDN"
        },
        "UserPass":{
            "$ref":"#/components/schemas/discoveryIncludesRead/properties/UserPass"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulUpdateOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulUpdateOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The properties of the updated inclusion profile.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/discoveryIncludesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulUpdateOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Updated record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Updated record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the updated inclusion profile.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The properties of the updated inclusion profile.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/discoveryIncludesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the updated inclusion profile.

Show Source

• Array of: object discoveryIncludesRead

{
    "description":"The properties of the updated inclusion profile.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/discoveryIncludesRead"
    }
}

Nested Schema : discoveryIncludesRead

Type: object

Show Source

• BaseDN: string
  LDAP base domain name

  Example: DC=localdomain,DC=local
• CDPSeeds: string
  CDP Seeds (e.g. 10.10.10.1,hostname,172.16.10.1)

  Example: oracle.doceng.json.BetterJsonNull@654db80b
• CIDR: string
  CIDR determines type of range expansion Allowed Values: - 1 => Glob expansion (e.g. 10.*.0-9.1,2,3,4) - 2 => CIDR expansion (e.g. 172.16.10.0/24)

  Example: oracle.doceng.json.BetterJsonNull@336070ab
• CIDRFlag: string
  CIDR Flag (Disabled or Enabled)

  Example: oracle.doceng.json.BetterJsonNull@20a4cba7
• DeviceZoneID: object DeviceZoneID
  Unique identifier for Device Zone.
• DeviceZoneName: string
  Device Zone name

  Example: Default First Zone
• Hops: integer
  Number of iterations for CDP discovery

  Example: oracle.doceng.json.BetterJsonNull@9de1b85
• IPRange: string
  IP Range (e.g. 10.*.0-9.1,2,3,4 for glob expansion; 172.16.10.0/24 for CIDR expansion)

  Example: 10.*.0-9.1
• ProfileID: integer
  Discovery Profile ID specified for individual CRUD operations

  Example: 3
• ProfileName: string
  Profile Name

  Example: Example Active Directory Scan
• ProfileStatus:
  Profile Status - Enabled - Disabled

  Example: Disabled
• ProfileStatusIcon: string
  Profile Status Icon

  Example: OrbRed.png
• ProfileStatusID: integer
  Profile Status ID Allowed Values: 0 => Disabled 1 => Enabled

  Example: 0
• ProfileType: string
  Profile Type Allowed Values: - Ping Scan - Seed Scan - LDAP Scan - CDP Scan

  Example: LDAP Scan
• ProfileTypeID: integer
  Profile Type ID Allowed Values: - 1 => Ping Scan - 2 => Seed Scan - 3 => LDAP Scan - 4 => CDP Scan

  Example: 3
• Query: string
  LDAP query text to produce server names

  Example: (objectClass=computer)
• Seeds: string
  Seeds (e.g. 10.10.10.1,hostname,172.16.10.1)

  Example: oracle.doceng.json.BetterJsonNull@3d3b4e09
• ServerName: string
  LDAP server fqdn host or IP Address

  Example: ldap.localdomain.local
• ServerPort: integer
  LDAP server port (tcp only)

  Example: 389
• UserDN: string
  LDAP base user name

  Example: monolith@localhost
• UserPass: string
  LDAP base user password

  Example: password

{
    "type":"object",
    "properties":{
        "ProfileTypeID":{
            "description":"Profile Type ID\n\nAllowed Values:\n- 1 => Ping Scan\n- 2 => Seed Scan\n- 3 => LDAP Scan\n- 4 => CDP Scan",
            "type":"integer",
            "example":"3"
        },
        "DeviceZoneID":{
            "description":"Unique identifier for Device Zone.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"Device Zone ID",
                    "type":"integer",
                    "example":"1"
                },
                "name":{
                    "description":"Name associated with the Device Zone ID",
                    "type":"string",
                    "example":"Default First Zone"
                }
            }
        },
        "CDPSeeds":{
            "description":"CDP Seeds (e.g. 10.10.10.1,hostname,172.16.10.1)",
            "type":"string",
            "nullable":true,
            "example":null
        },
        "Seeds":{
            "description":"Seeds (e.g. 10.10.10.1,hostname,172.16.10.1)",
            "type":"string",
            "example":null
        },
        "Hops":{
            "description":"Number of iterations for CDP discovery",
            "type":"integer",
            "nullable":true,
            "example":null
        },
        "ServerName":{
            "description":"LDAP server fqdn host or IP Address",
            "type":"string",
            "example":"ldap.localdomain.local"
        },
        "ServerPort":{
            "description":"LDAP server port (tcp only)",
            "type":"integer",
            "example":389
        },
        "BaseDN":{
            "description":"LDAP base domain name",
            "type":"string",
            "example":"DC=localdomain,DC=local"
        },
        "UserDN":{
            "description":"LDAP base user name",
            "type":"string",
            "example":"monolith@localhost"
        },
        "UserPass":{
            "description":"LDAP base user password",
            "type":"string",
            "example":"password"
        },
        "Query":{
            "description":"LDAP query text to produce server names",
            "type":"string",
            "example":"(objectClass=computer)"
        },
        "IPRange":{
            "description":"IP Range (e.g. 10.*.0-9.1,2,3,4 for glob expansion; 172.16.10.0/24 for CIDR expansion)",
            "type":"string",
            "example":"10.*.0-9.1"
        },
        "CIDR":{
            "description":"CIDR determines type of range expansion\n\nAllowed Values:\n- 1 => Glob expansion (e.g. 10.*.0-9.1,2,3,4)\n- 2 => CIDR expansion (e.g. 172.16.10.0/24)",
            "type":"string",
            "example":null
        },
        "CIDRFlag":{
            "description":"CIDR Flag (Disabled or Enabled)",
            "type":"string",
            "nullable":true,
            "example":null
        },
        "ProfileID":{
            "description":"Discovery Profile ID specified for individual CRUD operations",
            "type":"integer",
            "example":"3"
        },
        "ProfileName":{
            "description":"Profile Name",
            "type":"string",
            "example":"Example Active Directory Scan"
        },
        "ProfileStatusID":{
            "description":"Profile Status ID\n\nAllowed Values:\n  0 => Disabled\n  1 => Enabled",
            "type":"integer",
            "example":"0"
        },
        "ProfileStatusIcon":{
            "description":"Profile Status Icon",
            "type":"string",
            "example":"OrbRed.png"
        },
        "ProfileStatus":{
            "description":"Profile Status\n- Enabled\n- Disabled",
            "example":"Disabled"
        },
        "ProfileType":{
            "description":"Profile Type\n\nAllowed Values:\n- Ping Scan\n- Seed Scan\n- LDAP Scan\n- CDP Scan",
            "type":"string",
            "example":"LDAP Scan"
        },
        "DeviceZoneName":{
            "description":"Device Zone name",
            "type":"string",
            "example":"Default First Zone"
        }
    }
}

Nested Schema : DeviceZoneID

Type: object

Unique identifier for Device Zone.

Show Source

• id: integer
  Device Zone ID

  Example: 1
• name: string
  Name associated with the Device Zone ID

  Example: Default First Zone

{
    "description":"Unique identifier for Device Zone.",
    "type":"object",
    "properties":{
        "id":{
            "description":"Device Zone ID",
            "type":"integer",
            "example":"1"
        },
        "name":{
            "description":"Name associated with the Device Zone ID",
            "type":"string",
            "example":"Default First Zone"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top