MENU
    Create new Address object
    • 27 May 2025
    • 1 Minute to read
    • Contributors

      Create new Address object


        Article summary

        Post
        /v2.1/objects/addresses

        Required permission: ["objects:create"].

        Security
        HTTP
        Type bearer
        Body parameters
        object
        id
        string

        Unique Address ID

        name
        string Required

        The name of the Objects

        Min length3
        Max length100
        Pattern^[a-zA-Z0-9_ ]+$
        description
        string
        OneOf
        ObjectsAddressIP
        object (ObjectsAddressIP)
        valueType
        string Required
        Valid values[ "ip" ]
        value
        Array of string (IP) Required
        Min items1
        Max items1
        string (ipv4)
        ObjectsAddressIPList
        object (ObjectsAddressIPList)
        valueType
        string Required
        Valid values[ "list" ]
        value
        Array of string (IP) Required

        Must be a unique list of IPs

        Min items1
        string (ipv4)
        ObjectsAddressCIDR
        object (ObjectsAddressCIDR)
        valueType
        string Required
        Valid values[ "cidr" ]
        value
        Array of string (CIDR) Required
        Min items1
        Max items1
        string
        Pattern^((?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3})(\/(3[0-2]|[1-2][0-9]|[0-9]))$
        Responses
        201

        Created successfully

        object
        id
        string
        name
        string

        The name of the Objects

        Min length3
        Max length100
        Pattern^[a-zA-Z0-9_ ]+$
        description
        string
        OneOf
        ObjectsAddressIP
        object (ObjectsAddressIP)
        valueType
        string
        Valid values[ "ip" ]
        value
        Array of string (IP)
        Min items1
        Max items1
        string (ipv4)
        ObjectsAddressIPList
        object (ObjectsAddressIPList)
        valueType
        string
        Valid values[ "list" ]
        value
        Array of string (IP)

        Must be a unique list of IPs

        Min items1
        string (ipv4)
        ObjectsAddressCIDR
        object (ObjectsAddressCIDR)
        valueType
        string
        Valid values[ "cidr" ]
        value
        Array of string (CIDR)
        Min items1
        Max items1
        string
        Pattern^((?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3})(\/(3[0-2]|[1-2][0-9]|[0-9]))$
        400

        Bad request

        401

        Unauthorized

        403

        Forbidden

        Authentication
        Token
        *
        URL
        Body
        Response
        Click Try It! to start a request and see the response here!
        Code Samples

        Was this article helpful?

        Authentication
        Token
        *
        URL
        Body
        Response
        Click Try It! to start a request and see the response here!
        Code Samples