Contents x
    Get object services
    • 23 Jul 2025
    • 1 Minute to read
    • Contributors
      Contents

      Get object services

      • Updated on 23 Jul 2025
      • 1 Minute to read
      • Contributors
        Article summary

        Get
        /v2.2/objects/services

        Required permissions: ["objects:read"].

        Security
        HTTP
        Type bearer
        Responses
        200

        Completed successfully

        Expand All
        object
        data
        Array of object (ObjectsServicesResponseObj)
        object
        name
        string

        The name of the Objects

        Min length3
        Max length100
        Pattern^[a-zA-Z0-9_ ]+$
        description
        string
        protocols
        Array of object (ObjectsServicesProtocolResponseObj)
        AnyOf
        ObjectServiceProtocolTCPUDP
        object (ObjectServiceProtocolTCPUDP)
        OneOf
        ObjectServiceProtocolSingle
        object (ObjectServiceProtocolSingle)
        valueType
        string
        Valid values[ "single" ]
        value
        Array of integer (PortNumber)
        Min items1
        Max items1
        integer
        Minimum1
        Maximum65535
        ObjectServiceProtocolRange
        object (ObjectServiceProtocolRange)
        valueType
        string
        Valid values[ "range" ]
        value
        Array of integer (PortNumber)
        Min items2
        Max items2
        integer
        Minimum1
        Maximum65535
        ObjectServiceProtocolList
        object (ObjectServiceProtocolList)
        valueType
        string
        Valid values[ "list" ]
        value
        Array of integer (PortNumber)
        Min items1
        integer
        Minimum1
        Maximum65535
        ObjectServiceProtocolICMPResponse
        object (ObjectServiceProtocolICMPResponse)
        protocol
        string
        Valid values[ "icmp" ]
        protocolOptions
        object (ObjectServiceProtocolOptionsICMPresponse)

        -1 means 'any', the rest of the values are the RFC default ICMP parameters

        Valid values[ { "code": -1, "description": "Any" }, { "code": 0, "description": "Echo Reply" }, { "code": 3, "description": "Destination Unreachable" }, { "code": 5, "description": "Redirect" }, { "code": 8, "description": "Echo" }, { "code": 9, "description": "Router Advertisement" }, { "code": 10, "description": "Router Selection" }, { "code": 11, "description": "Time Exceeded" }, { "code": 12, "description": "Parameter Problem" }, { "code": 13, "description": "Timestamp" }, { "code": 14, "description": "Timestamp Reply" }, { "code": 40, "description": "Photuris" }, { "code": 42, "description": "Extended Echo Request" }, { "code": 43, "description": "Extended Echo Reply" } ]
        code
        integer
        description
        string
        page
        number
        Minimum0
        Maximum500
        totalPage
        number
        Minimum0
        Maximum500
        itemsTotal
        number
        Minimum0
        Maximum500
        401

        Unauthorized

        403

        Forbidden

        Was this article helpful?
        What's Next