Get Site

Infra API · Sites

GET https://app.mk.io/api/v1/projects/{project_name}/infra/sites/{name}

Get a site by name. To learn more about sites, read Site Concept.

RBAC Capability Required: infra.site.get

Authentication

• Authorization header — Bearer authentication of the form Bearer <token>.

Path parameters

Example request

curl -X GET "https://app.mk.io/api/v1/projects/{project_name}/infra/sites/{name}" \
  -H "Authorization: Bearer <token>"

Responses

200 — A single site

• kind · string · Required — The kind of record.
• metadata · object · 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 — map of additional properties
  • 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 · Required — Site specification.
  • geolocation · object · Optional — Optional geolocation data for the site.
    • coordinates · list of doubles · Required · 0-2 items — 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.
      • Array items (double):
  • routes · list of objects · Optional — The routes that connect the network to <glossary:site>s.
    • Array items (object):
      • defaultTransport · object · 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 · _Defaults to _ — 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 · 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

Example:

{
  "kind": "string",
  "metadata": {
    "created": "2024-01-01T00:00:00Z",
    "createdBy": "00000000-0000-0000-0000-000000000000",
    "createdByEmail": "string",
    "displayName": "string",
    "id": "00000000-0000-0000-0000-000000000000",
    "labels": {
      "label1": "value1",
      "label2": "value2"
    },
    "name": "string",
    "updated": "2024-01-01T00:00:00Z",
    "updatedBy": "00000000-0000-0000-0000-000000000000",
    "updatedByEmail": "string"
  },
  "spec": {
    "geolocation": {
      "coordinates": [
        0
      ]
    },
    "routes": [
      {
        "defaultTransport": {
          "cidr": "239.0.0.1/24",
          "type": "UDP"
        },
        "networkName": "internet"
      }
    ]
  },
  "status": {
    "locationDisplayName": "string",
    "locationName": "string",
    "owner": "User"
  }
}

400 — Bad Request

• error · object · Required — Pertinent information about the error
  • code · string · Required — The error code.
  • detail · string · Required — The error message.
  • extraDetail · map from strings to any · Optional — Extra information regarding this error.
    • [any key] · any — map of additional properties
• ref · string · Required — A reference to the request that caused the error.
• status · integer · Required — The HTTP status code

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

401 — Unauthorized

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

403 — Forbidden

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

404 — Not Found

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

429 — Too Many Requests

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

500 — Internal Server Error

Example:

{
  "error": {
    "code": "string",
    "detail": "string",
    "extraDetail": {
      "key": null
    }
  },
  "ref": "string",
  "status": 0
}

Source spec: infrastructure-api · operationId: [get]_/api/v1/projects/{project_name}/infra/sites/{name}