> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://mediakind.ferndocs.com/beam/api/infrastructure/sites/create-site/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # Create Site PUT https://app.mk.io/api/v1/projects/{project_name}/infra/sites/{name} Content-Type: application/json Create a site. To learn more about sites, read [Site Concept](ref:infrastructure-api#site-concept). RBAC Capability Required: `infra.site.create` Reference: https://mediakind.ferndocs.com/beam/api/infrastructure/sites/create-site ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `project_name` (string, required) - `name` (string, required) ### Body (application/json) This endpoint expects a SiteBody. - `metadata` (DefaultMetadata, required) — Resource metadata. - `spec` (SiteBodySpec, optional) — Site specification. ## Response ### 201 The created site - `kind` (string, required) — The kind of record. - `metadata` (MetadataSchema, required) — Site metadata. - `spec` (SiteBodySpec, required) — Site specification. - `status` (SiteBodyStatus, required) — Site status. ## Errors ### 400 Bad Request Error Bad Request - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 401 Unauthorized Error Unauthorized - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 403 Forbidden Error Forbidden - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 404 Not Found Error Not Found - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 409 Conflict Error Conflict - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 429 Too Many Requests Error Too Many Requests - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ### 500 Internal Server Error Internal Server Error - `error` (ErrorDetail, required) — Pertinent information about the error - `ref` (string, required) — A reference to the request that caused the error. - `status` (integer, required) — The HTTP status code ## Types ### DefaultMetadata - `displayName` (string, required) — A human-readable name for the resource. - `labels` (map from string to string, optional) — A dictionary of labels associated with the resource. Maximum number of labels: 32. Maximum length of a label or value: 256 characters. Label: alphanumeric, hyphens and underscores. Value: alphanumeric, hyphens, underscores and spaces. ### SiteBodySpec - `geolocation` (GeolocationFragment, optional) — Optional geolocation data for the site. - `routes` (list of RouteJsonFragment, optional) — The routes that connect the network to \<\>s. ### MetadataSchema - `id` (string, required) — The ID of the resource - `created` (datetime, optional) — The time when the resource was created - `createdBy` (string, optional) — 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 - `labels` (map from string to string, optional) — A dictionary of labels associated with the resource - `name` (string, optional) — The name of the resource - `updated` (datetime, optional) — The time when the resource was last updated - `updatedBy` (string, optional) — ID of the user who last updated the resource - `updatedByEmail` (string, optional) — Email of the user who last updated the resource ### SiteBodyStatus - `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](ref:infrastructure-api#system-owned-sites). - Allowed values: `User`, `System` - `locationDisplayName` (string, optional) — Display name of the location of this site. This field is only relevant for \<\>s. To learn more, read [Sites](ref:infrastructure-api#site-concept). - `locationName` (string, optional) — Name of the location of this site. This field is only relevant for \<\>s. To learn more, read [Sites](ref:infrastructure-api#site-concept). ### ErrorDetail - `code` (string, required) — The error code. - `detail` (string, required) — The error message. - `extraDetail` (map from string to any, optional) — Extra information regarding this error. ### GeolocationFragment - `coordinates` (list of double, 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. ### RouteJsonFragment - `networkName` (string, required) — The name of the \<\> connected to the site by this route. - `defaultTransport` (DefaultTransport, optional) — Settings used to influence the \<\> that the system will automatically select when it needs to send \<\> from one \<\> 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](ref:infrastructure-api#default-transports) to learn more. ### DefaultTransport - `type` (enum, required) — The type of \<\> to use for sending content from one flow to another flow. - Allowed values: `Auto`, `SRTListener`, `SRTCaller`, `UDP`, `RISTListener` - `cidr` (string, optional, default: ) — 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. ## Examples **Request** ```json { "metadata": { "displayName": "string" } } ``` **Response** ```json { "kind": "string", "metadata": { "id": "string", "created": "2024-01-15T09:30:00Z", "createdBy": "string", "createdByEmail": "string", "displayName": "string", "labels": { "label1": "value1", "label2": "value2" }, "name": "string", "updated": "2024-01-15T09:30:00Z", "updatedBy": "string", "updatedByEmail": "string" }, "spec": { "geolocation": { "coordinates": [ 1.1 ] }, "routes": [ { "networkName": "internet", "defaultTransport": { "type": "UDP", "cidr": "239.0.0.1/24" } } ] }, "status": { "owner": "User", "locationDisplayName": "string", "locationName": "string" } } ``` **SDK Code** ```python import requests url = "https://app.mk.io/api/v1/projects/project_name/infra/sites/name" payload = { "metadata": { "displayName": "string" } } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.put(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.mk.io/api/v1/projects/project_name/infra/sites/name'; const options = { method: 'PUT', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"metadata":{"displayName":"string"}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://app.mk.io/api/v1/projects/project_name/infra/sites/name" payload := strings.NewReader("{\n \"metadata\": {\n \"displayName\": \"string\"\n }\n}") req, _ := http.NewRequest("PUT", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://app.mk.io/api/v1/projects/project_name/infra/sites/name") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Put.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"metadata\": {\n \"displayName\": \"string\"\n }\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.put("https://app.mk.io/api/v1/projects/project_name/infra/sites/name") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"metadata\": {\n \"displayName\": \"string\"\n }\n}") .asString(); ``` ```php request('PUT', 'https://app.mk.io/api/v1/projects/project_name/infra/sites/name', [ 'body' => '{ "metadata": { "displayName": "string" } }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/infra/sites/name"); var request = new RestRequest(Method.PUT); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"metadata\": {\n \"displayName\": \"string\"\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["metadata": ["displayName": "string"]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/projects/project_name/infra/sites/name")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PUT" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```