SiteGetSchema

Parameters

• kind: string (Required)
  The kind of record.

• metadata: object [MetadataSchema] (Required)
  Site metadata.

• created: string (Optional)

  • format: date-time
    The time when the resource was created.

  • createdBy: string (Optional)

    • format: uuid
      ID of the user who created the resource.

  • createdByEmail: string (Optional)
    Email of the user who created the resource.

  • displayName: string (Optional)
    The display name of the resource.

  • id: string (Required)

    • format: uuid
      The ID of the resource.

  • labels: map from strings to string (Optional)
    A dictionary of labels associated with the resource.

    • [any key]: string

  • name: string (Optional)
    The name of the resource.

  • updated: string (Optional)

    • format: date-time
      The time when the resource was last updated.

  • updatedBy: string (Optional)

    • format: uuid
      ID of the user who last updated the resource.

  • updatedByEmail: string (Optional)
    Email of the user who last updated the resource.

• spec: object [SiteBodySpec] (Required)
  Site specification.

• geolocation: object [GeolocationFragment] (Optional)
  Optional geolocation data for the site.

  • coordinates: list of doubles (Required)
    Co-ordinates that describe the geolocation (ISO 6709), an array of two floating point numbers [latitude(North - South), longitude(East - West)]. Set an empty array to clear the geolocation.
  • routes: list of objects [RouteJsonFragment] (Optional)
    The routes that connect the network to glossary:sites.

• defaultTransport: object [DefaultTransport] (Optional)
  Settings used to influence the glossary:transport that the system will automatically select when it needs to send glossary:content from one glossary:flow to another flow. The default transport settings from the route on which the content enters the network are used to select and configure the transport for the content. Read Default transports to learn more.
  - cidr: string (Optional)
  The IP address range to choose from when the system automatically creates transport settings for sending content from one flow to another. If a specific IP/URL (such as a public cloud IP or a fleet device IP) is required to send content between flows, then this setting will be ignored. - type: enum (Required)
  The type of glossary:transport to use for sending content from one flow to another flow.
  - Allowed values: Auto, SRTListener, SRTCaller, UDP, RISTListener

• networkName: string (Required)

  • pattern: ^a-z0-9?$
    The name of the glossary:network connected to the site by this route.

• status: object [SiteBodyStatus] (Required)
  Site status.

• locationDisplayName: string (Optional)
  <=255 characters
  Display name of the location of this site. This field is only relevant for <<glossary:SaaS site>>s. To learn more, read Sites.

  • locationName: string (Optional)
    • pattern: ^a-z0-9?$
      Name of the location of this site. This field is only relevant for <<glossary:SaaS site>>s. To learn more, read Sites.
  • owner: enum (Required)
    Indicates whether the site was automatically created by the system. System owned sites cannot be deleted, but they can be modified. To learn more, read System owned sites.
    • Allowed values: User, System