> 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/networks/get-network/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server. # Get Network GET https://app.mk.io/api/v1/projects/{project_name}/infra/networks/{name} Get a network by name. To learn more about networks, read [Network Concept](ref:infrastructure-api#network-concept). RBAC Capability Required: `infra.network.get` Reference: https://mediakind.ferndocs.com/beam/api/infrastructure/networks/get-network ## 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) ## Response ### 200 A single Network - `kind` (string, required) — The kind of record. - `metadata` (MetadataSchema, required) — Network metadata. - `spec` (NetworkBodySpec, required) — Network specification. - `status` (NetworkBodyStatus, required) — Network 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 ### 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 ### 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 ### NetworkBodySpec ### NetworkBodyStatus - `owner` (enum, required) — Indicates whether the network was automatically created by the system. System owned networks cannot be deleted, but they can be modified. To learn more, read [System owned networks](ref:infrastructure-api#system-owned-networks). - Allowed values: `User`, `System` - `scope` (enum, required) — Indicates whether the network is a local network within a site. Local networks are always system owned and therefore cannot be deleted, however they can be modified. - Allowed values: `Connecting`, `Local` ### 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. ## Examples **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": {}, "status": { "owner": "User", "scope": "Connecting" } } ``` **SDK Code** ```python import requests url = "https://app.mk.io/api/v1/projects/project_name/infra/networks/name" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://app.mk.io/api/v1/projects/project_name/infra/networks/name'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; 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" "net/http" "io" ) func main() { url := "https://app.mk.io/api/v1/projects/project_name/infra/networks/name" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") 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/networks/name") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://app.mk.io/api/v1/projects/project_name/infra/networks/name") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://app.mk.io/api/v1/projects/project_name/infra/networks/name', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://app.mk.io/api/v1/projects/project_name/infra/networks/name"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://app.mk.io/api/v1/projects/project_name/infra/networks/name")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers 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() ```