Contents x
    Schemas
    • 01 Aug 2023
    • 1 Minute to read
    • Contributors
      Contents

      Schemas

      • Updated on 01 Aug 2023
      • 1 Minute to read
      • Contributors
        Article Summary

        Request Headers

        Each request must include the following request headers:

        PropertyData TypeDescription
        Authorization*StringYour temporary Access Token obtained using the /authorize method
        Content-Type*
        		String
        		application/json

        Request Body Schemas

        Networks

        Networks contain information about the different Perimeter 81 networks within the platform.

        Network

        Network information. Found in NetworkList.

        PropertyData TypeDescription
        geoPoint*NetworkGeoPointNetwork geographical point information.
        name*StringName of network.
        isDefault*BooleanWhether network is the default (true).
        regions*Array of NetworkRegionList of network regions.
        id*StringID of network.

        NetworkGeoPoint

        Geographical point information. Found in Network and NetworkRegion.

        PropertyData TypeDescription
        __type*StringGeo point type. Private.
        latitude*NumberGeo point latitude.
        longitude*NumberGeo point longitude.

        NetworkHealth

        Health status of network health. Response to GET /v1/networks/{id}.

        PropertyData TypeDescription
        health*Array of NetworkStatusList of network statuses.

        NetworkInstance

        A network instance. Found in NetworkRegion.

        PropertyData TypeDescription
        tunnels*StringTunnels.
        id*StringID of instance.

        NetworkList

        List of networks. Response to GET /v1/networks.

        PropeertyData TypeDescription
        data*Array of NetworkList of networks.

        NetworkMeta

        Metadata for a network. Found in NetworkStatus.

        PropertyData TypeDescription
        networkId*StringID of network.
        instanceId*StringID of instance.
        tunnelName*StringName of tunnel

        NetworkProvider

        Provider of the network. Found in NetworkRegion.

        PropertyData TypeDescription
        region*StringProvider region.
        continentCode*StringProvider continent code.
        countryCode*StringProvider country code.

        NetworkRegion

        Network region. Found in Network.

        PropertyData TypeDescription
        geoPoint*NetworkGeoPointNetwork's geographical points.
        name*StringName of region.
        instances*Array of NetworkInstanceList of network instances.
        provider*NetworkProviderNetwork provider.
        id*StringID of region.

        NetworkStatus

        Status of an individual network. Found in NetworkHealth.

        PropertyData TypeDescription
        type*StringNetwork type. Currently, only 'gateway'.
        meta*NetworkMetaMetadata for a network.
        status*BooleanWhether network is active (true).
        Was this article helpful?
        What's Next