Jump to

• Request
• Response

Create an Exclusion Profile

post

/api/discovery/Excludes

Creates a new exclusion profile.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object schema

{
    "allOf":[
        {
            "$ref":"#/components/schemas/discoveryExcludes"
        }
    ],
    "required":[
        "ProfileName",
        "ProfileDescr",
        "DeviceZoneID",
        "ProfileStatusID",
        "ProfileTypeID"
    ]
}

Nested Schema : schema

Type: object

Show Source

• DeviceZoneID: integer
  Unique identifier for Device Zone.

  Example: 1
• IPRange: string
  IP Range (e.g. 10.*.0-9.1,2,3,4) to be excluded. If ProfileTypeID is 1, then it is required.

  Example: 0.0.0-1.*
• ProfileDescr: string
  Profile Description (why the devices are being excluded)

  Example: This is an example of excluding a list of devices from discovery
• ProfileName: string
  Profile Name

  Example: Example Device List
• ProfileStatusID: integer
  Profile Status ID Allowed Values: - 0 => Disabled - 1 => Enabled

  Example: 0
• ProfileTypeID: integer
  Profile Type ID Allowed Values: - 1 => IP Range - 2 => Device List

  Example: 1
• Seeds: string
  Seeds (e.g. 10.10.10.1,hostname,172.16.10.1) to be excluded. If ProfileTypeID is 2, then it is required.

  Example: 192.168.100.255,10.10.10.255

{
    "type":"object",
    "properties":{
        "ProfileName":{
            "$ref":"#/components/schemas/discoveryExcludesRead/properties/ProfileName"
        },
        "ProfileDescr":{
            "$ref":"#/components/schemas/discoveryExcludesRead/properties/ProfileDescr"
        },
        "DeviceZoneID":{
            "description":"Unique identifier for Device Zone.",
            "type":"integer",
            "example":"1"
        },
        "ProfileStatusID":{
            "$ref":"#/components/schemas/discoveryExcludesRead/properties/ProfileStatusID"
        },
        "ProfileTypeID":{
            "description":"Profile Type ID\n\nAllowed Values:\n- 1 => IP Range\n- 2 => Device List",
            "type":"integer",
            "example":1
        },
        "IPRange":{
            "description":"IP Range (e.g. 10.*.0-9.1,2,3,4) to be excluded.  If ProfileTypeID is 1, then it is required.",
            "type":"string",
            "example":"0.0.0-1.*",
            "nullable":true
        },
        "Seeds":{
            "description":"Seeds (e.g. 10.10.10.1,hostname,172.16.10.1) to be excluded. If ProfileTypeID is 2, then it is required.",
            "type":"string",
            "example":"192.168.100.255,10.10.10.255",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
• object type

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

Nested Schema : SuccessfulAddOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Added 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":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The properties of the new exclusion 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 new exclusion profile.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/discoveryExcludesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The properties of the new exclusion profile.

Show Source

• Array of: object discoveryExcludesRead

{
    "description":"The properties of the new exclusion profile.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/discoveryExcludesRead"
    }
}

Nested Schema : discoveryExcludesRead

Type: object

Show Source

• DeviceZoneID: object DeviceZoneID
  Unique identifier for Device Zone.
• DeviceZoneName: string
  Device Zone Name

  Example: Default First Zone
• IPRange: string
  IP Range (e.g. 10.*.0-9.1,2,3,4) to be excluded

  Example: 0.0.0-1.*
• ProfileDescr: string
  Profile Description (why the devices are being excluded)

  Example: This is an example of excluding a list of devices from discovery
• ProfileID: integer
  Discovery Profile ID specified for individual CRUD operations

  Example: 2
• ProfileName: string
  Profile Name

  Example: Example Device List
• ProfileStatus: string
  Profile Status

  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: - 1 => IP Range - 2 => Device List

  Example: Device List
• Seeds: string
  Seeds (e.g. 10.10.10.1,hostname,172.16.10.1) to be excluded

  Example: 192.168.100.255,10.10.10.255

{
    "type":"object",
    "properties":{
        "ProfileStatusID":{
            "description":"Profile Status ID\n\nAllowed Values:\n- 0 => Disabled\n- 1 => Enabled",
            "type":"integer",
            "example":"0"
        },
        "ProfileStatus":{
            "description":"Profile Status",
            "type":"string",
            "example":"Disabled"
        },
        "DeviceZoneID":{
            "description":"Unique identifier for Device Zone.",
            "type":"object",
            "properties":{
                "id":{
                    "description":"Device Zone ID",
                    "type":"integer",
                    "example":"1"
                },
                "name":{
                    "description":"Device Zone name associated with ID",
                    "type":"string",
                    "example":"Default First Zone"
                }
            }
        },
        "Seeds":{
            "description":"Seeds (e.g. 10.10.10.1,hostname,172.16.10.1) to be excluded",
            "type":"string",
            "example":"192.168.100.255,10.10.10.255",
            "nullable":true
        },
        "IPRange":{
            "description":"IP Range (e.g. 10.*.0-9.1,2,3,4) to be excluded",
            "type":"string",
            "example":"0.0.0-1.*",
            "nullable":true
        },
        "ProfileID":{
            "description":"Discovery Profile ID specified for individual CRUD operations",
            "type":"integer",
            "example":"2"
        },
        "ProfileName":{
            "description":"Profile Name",
            "type":"string",
            "example":"Example Device List"
        },
        "ProfileDescr":{
            "description":"Profile Description (why the devices are being excluded)",
            "type":"string",
            "example":"This is an example of excluding a list of devices from discovery"
        },
        "ProfileStatusIcon":{
            "description":"Profile Status Icon",
            "type":"string",
            "example":"OrbRed.png"
        },
        "ProfileType":{
            "description":"Profile Type\n\nAllowed Values:\n- 1 => IP Range\n- 2 => Device List",
            "type":"string",
            "example":"Device List"
        },
        "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
  Device Zone name associated with 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":"Device Zone name associated with 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