Create new 'Service' object
  • 22 Nov 2023
  • 1 Minute to read
  • Contributors

    Create new 'Service' object


      Article Summary

      Post
      /v2/objects/services

      Required permission: ["objects:create"].

      Security
      Http
      Type bearer
      Body parameters
      object
      name
      string Required

      The name of the Objects

      Max length100
      Min length3
      Pattern^[a-zA-Z0-9_ ]+$
      description
      string
      protocols
      Array of object (ObjectsServicesProtocolRequestObj) Required
      AnyOf
      ObjectServiceProtocolTCPUDP
      protocol
      string Required
      Valid values[ "tcp", "udp" ]
      ObjectServiceProtocolICMPRequest
      protocol
      string Required
      Valid values[ "icmp" ]
      protocolOptions
      integer Required

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

      Valid values[ -1, 0, 3, 5, 8, 9, 10, 11, 12, 13, 14, 40, 42, 43 ]
      Responses
      201

      Created successfully

      Expand All
      object
      id
      string
      name
      string

      The name of the Objects

      Max length100
      Min length3
      Pattern^[a-zA-Z0-9_ ]+$
      description
      string
      protocols
      Array of object (ObjectsServicesProtocolResponseObj)
      AnyOf
      ObjectServiceProtocolTCPUDP
      protocol
      string
      Valid values[ "tcp", "udp" ]
      ObjectServiceProtocolICMPResponse
      protocol
      string
      Valid values[ "icmp" ]
      protocolOptions
      object (ObjectServiceProtocolOptionsICMPresponse)

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

      code
      integer
      description
      string
      401

      Unauthorized

      403

      Forbidden


      Was this article helpful?