Remove one or many tasks from a label within a project.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","labels",":label_id","tasks"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[{"id":"4cdc8923-792d-4ddd-8a6d-f2f407f9707a","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"a7c6e340-2250-44a9-aaa6-221c1cd9a7d2","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"label_id"}]}},"response":[{"id":"81854102-314f-4538-a702-1fd7b62fc2a2","name":"response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerGet details of a specific label.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","labels",":label_id"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[{"id":"1b218f95-fcd6-4e70-b393-0d696d6f03df","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"e1bc3408-13a2-4c5a-9f45-b0327dcaa880","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"label_id"}]}},"response":[{"id":"c276002a-a80d-4a57-bd66-e9ce98ef05ce","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerUpdate an existing label within a project.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","labels",":label_id"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[{"id":"22128e7e-36d4-43d3-a8d5-974f811d34f7","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"0cab886a-ad96-428b-a86e-bd9600c2991e","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"label_id"}]}},"response":[{"id":"77a7205e-a728-49f3-be9e-d4ab89067b37","name":"200 Ok","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"638c2926-cdb6-4b4c-a5f7-499751c387c1","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"label_id"}]}},"response":[{"id":"716b3437-49d8-44b1-9323-252d002a17ad","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerHere are code example demonstrating how to get labels from a project.
\nendpoint = f\"https://{API_ENDPOINT_DOMAIN}/projects/{PROJECT_SHORT_NAME}/labels/{LABEL_ID}\"\n\nheaders = {\"Accept\": CONTENT_TYPE, \"Authorization\": f\"Bearer {session_token}\"}\n\nresponse = requests.get(url=endpoint, headers=headers, timeout=10)\n\nRetrieve a list of labels from within a project.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","labels"],"host":["api","test","rendernetworks","com"],"query":[{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"page_limit","value":"500"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"label_type","value":"General"}],"variable":[{"id":"236a9163-2bd2-4353-bea9-e6326c592b6a","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"}]}},"response":[{"id":"75128d87-666d-487f-9464-ef730e7d24ca","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerCreate a new label within a project.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","labels"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[{"id":"af963e80-09d9-4366-bfbd-c8b2007246a0","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"}]}},"response":[{"id":"7afb4e1e-1d82-4e0f-a689-9a1dbf1b3591","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerUse labels to communicate project state as it pertains to 3rd party systems integration. This will include Adding and Removing labels to simplify communication for everyone.
\nPython Example
\nimport logging\nimport sys\nimport requests\n# Please refer to \"Getting Started with Render API\" section @ https://developer.rendernetworks.com/\nPROJECT_SHORT_NAME = \"<Project Short Name>\"\nCLIENT_ID = \"<Client ID>\"\nCLIENT_SECRET = \"<Client Secret>\"\nAUTH_DOMAIN = \"<Auth Domain>\"\nAPI_ENDPOINT_DOMAIN = \"<API Endpoint Domain>\"\nCONTENT_TYPE = \"application/json\"\nLABEL_ID = \"<Label ID to find>\"\ndef get_access_token(auth_domain, client_id, client_secret):\n \"\"\"\n Generate access token by given client id and secret.\n The access token is used as bearer token for accessing the backend api endpoints\n \"\"\"\n token_provider_endpoint = f\"https://{auth_domain}/oauth2/default/v1/token\"\n headers = {\"accept\": CONTENT_TYPE, \"cache-control\": \"no-cache\", \"content-type\": \"application/x-www-form-urlencoded\"}\n data = {\"grant_type\": \"client_credentials\", \"scope\": \"customScope\"}\n response = requests.post(\n url=token_provider_endpoint, auth=(client_id, client_secret), headers=headers, data=data, timeout=10\n )\n return response.json()[\"access_token\"]\nif __name__ == \"__main__\":\n logger = logging.getLogger()\n consoleHandler = logging.StreamHandler(sys.stdout)\n logger.addHandler(consoleHandler)\n logger.setLevel(logging.INFO)\n # Generate session token\n session_token = get_access_token(AUTH_DOMAIN, CLIENT_ID, CLIENT_SECRET)\n logger.info(f\"Session token: {session_token}\")\n headers = {\"Accept\": CONTENT_TYPE, \"Authorization\": f\"Bearer {session_token}\"}\n base_url = f\"https://{API_ENDPOINT_DOMAIN}/projects/{PROJECT_SHORT_NAME}\"\n # Get Labels\n logger.info(\"Getting Labels ................ \")\n endpoint = f\"{base_url}/labels?page=1&page_limit=500\"\n response = requests.get(url=endpoint, headers=headers, timeout=10)\n logger.info(f\"Labels Response: {response.json()}\")\n\nhttps://developer.rendernetworks.com/labels
\n","_postman_id":"7bc57723-49b0-4679-9a18-4eabf0fcedec","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}}},{"name":"tasks","item":[{"name":"{project_task_id}","item":[{"name":"labels","item":[{"name":"Add many Labels to Task","id":"0ce720ec-fad2-4cb8-ac4b-2bd0917fdd83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"labels\": []\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"https://api.test.rendernetworks.com/projects/:project_short_name/tasks/:project_task_id/labels","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","tasks",":project_task_id","labels"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[{"id":"28653002-4ecd-4f0b-bc0d-dec57818aa73","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"2d3777e1-80df-443a-9883-8c1e21d0779f","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"86e33953-183d-4253-9c53-db3a2abff89f","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"c4897d85-12ae-4c76-aeb0-78f834b4d8ac","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"ac73e15c-9b13-497d-afb9-90f90aeeadb8","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"883534c5-e7a7-4333-9bd5-78feed828675","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"},{"id":"54f8a181-762a-4a17-8781-0b20d251ae40","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"dependency_task_id"}]}},"response":[{"id":"6ec6b221-ed95-41eb-a425-75f1555185c3","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) The current page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"(Required) The number of records to be shown/fetched per page
\n","type":"text/plain"},"key":"page_limit","value":"500"}],"variable":[{"id":"c5be2760-19f5-4bad-abbc-feec11c91588","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"e8974643-bc8d-4d45-bbed-47f79f6619a4","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"d6c2ac1a-de8d-4f28-90e9-a54138ae8abb","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"11266622-e092-44a5-89e1-60a3ef3ff618","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"bf213501-f3b3-4094-9f31-d682c3b04a1e","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"34ed11ca-1a7b-4d6e-b098-8a4e579da8be","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"0e37b0a3-ed25-4a4c-bf25-083a652a4ec1","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerWorkflow Example: Constructing a Fiber Optic Splice Enclosure
\nTask A: Install the Splice Enclosure Mount
\nSecure the enclosure mount to the designated pole or underground location.
\nDependency: None
\nTask B: Splice the Fiber Optic Cables
\nConnect and splice the fiber cables within the enclosure according to network design.
\nDependency: Task A (Enclosure mount installation) must be completed to provide a stable base.
\nTask C: Seal and Test the Enclosure
\nClose the enclosure, seal it to protect against environmental conditions, and test for signal integrity.
\nDependency: Task B (Fiber splicing) must be completed to ensure all connections are properly made.
\n","_postman_id":"45a80df8-e9f1-420d-b516-b42fd048eef9","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}}},{"name":"dependents","item":[{"name":"{dependent_task_id}","item":[{"name":"Delete Task Dependent","id":"c7ba1bfc-5cf9-4202-8945-a58d97f56f61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://api.test.rendernetworks.com/projects/:project_short_name/tasks/:project_task_id/dependents/:dependent_task_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","tasks",":project_task_id","dependents",":dependent_task_id"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[{"id":"b611ed2d-4762-4ad1-a623-474642087c79","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"48c018f6-a6ea-4096-9bd7-7addbd7eefd8","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"},{"id":"6d2e3c09-cced-4c1f-84d1-9e7567b1a89d","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"dependent_task_id"}]}},"response":[{"id":"32539bd8-d787-4700-bbb7-1e12525ccd5e","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required) The current page number
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"(Required) The number of records to be shown/fetched per page
\n","type":"text/plain"},"key":"page_limit","value":"500"}],"variable":[{"id":"1b22deff-4aad-4335-a819-0941b38c501d","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"cbf443b6-706c-434a-be5d-e85c0a45ade1","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"f161047a-b091-4a80-8759-ff2598a60296","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"70094855-2836-4da7-a01f-03459a2238d3","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"6a028089-fd20-4da3-848f-07eed35ce3ec","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"ee873c1a-d5b7-4212-87b7-d18dd3c47224","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"920e9603-1585-4d22-be63-d24b3a612636","name":"200 OK","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"page_limit","value":"500"}],"variable":[{"id":"ba72abb3-ed41-4dd3-b94f-9a0525597515","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"eb7b2b95-0b2e-4952-b230-755ca75e9ada","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"05d253c0-7b9b-46b9-be7c-e42102b2b09b","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerWhen calling the endpoints or , you may see some photos attached to the task, while that only presents a few details such as the name and type, you may retrieve the image url and further information from this endpoint.
\nPython Example
\nimport logging\nimport sys\nimport requests\n\n\n# Please refer to \"Getting Started with Render API\" section @ https://developer.rendernetworks.com/\nPROJECT_SHORT_NAME = \"<Project Short Name>\"\nCLIENT_ID = \"<Client ID>\"\nCLIENT_SECRET = \"<Client Secret>\"\nAUTH_DOMAIN = \"<Auth Domain>\"\nAPI_ENDPOINT_DOMAIN = \"<API Endpoint Domain>\"\nCONTENT_TYPE = \"application/json\"\nPROJECT_TASK_ID = \"<Project Task ID to update>\"\n\n\ndef get_access_token(auth_domain, client_id, client_secret):\n \"\"\"\n Generate access token by given client id and secret.\n The access token is used as bearer token for accessing the backend api endpoints\n \"\"\"\n token_provider_endpoint = f\"https://{auth_domain}/oauth2/default/v1/token\"\n headers = {\"accept\": CONTENT_TYPE, \"cache-control\": \"no-cache\", \"content-type\": \"application/x-www-form-urlencoded\"}\n data = {\"grant_type\": \"client_credentials\", \"scope\": \"customScope\"}\n response = requests.post(\n url=token_provider_endpoint, auth=(client_id, client_secret), headers=headers, data=data, timeout=10\n )\n return response.json()[\"access_token\"]\n\n\nif __name__ == \"__main__\":\n logger = logging.getLogger()\n consoleHandler = logging.StreamHandler(sys.stdout)\n logger.addHandler(consoleHandler)\n logger.setLevel(logging.INFO)\n\n # Generate session token\n session_token = get_access_token(AUTH_DOMAIN, CLIENT_ID, CLIENT_SECRET)\n logger.info(f\"Session token: {session_token}\")\n\n headers = {\"Accept\": CONTENT_TYPE, \"Authorization\": f\"Bearer {session_token}\"}\n base_url = f\"https://{API_ENDPOINT_DOMAIN}/projects/{PROJECT_SHORT_NAME}/tasks/{PROJECT_TASK_ID}\"\n\n # Get Task Photos\n logger.info(\"Getting Task Photos ................ \")\n endpoint = f\"{base_url}/photos?page=1&page_limit=500\"\n response = requests.get(url=endpoint, headers=headers, timeout=10)\n logger.info(f\"Task Photo Response: {response.json()}\")\n\nhttps://developer.rendernetworks.com/2nyO-get-task-photos
\n","_postman_id":"cd2c2a7b-e363-48bf-9e72-c72f472ad7db","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}}},{"name":"Get Task","id":"d2fe4518-4fc6-4df4-91e3-7debbc688ed9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.test.rendernetworks.com/projects/:project_short_name/tasks/:project_task_id","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","tasks",":project_task_id"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[{"id":"73269521-6db1-401f-9f40-3cee21dd1437","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"178bbcbd-5633-43a4-a96c-66545c4096b4","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"a0888d12-880c-4aff-b186-7da161cfb148","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"e0b1557a-0afc-4567-b3d6-3003a8ee3527","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"pariatur","key":"project_task_id"}]}},"response":[{"id":"867f0669-4de7-460f-ae27-af036237e672","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"}]}},"response":[{"id":"cddc2634-9cd6-470e-be7e-7e192136cc64","name":"200 OK","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"page_limit","value":"500"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"status","value":"completed"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"asbuilt","value":"true"}],"variable":[{"id":"c16c4c1e-c9c5-4015-bce2-d084916a9574","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"}]}},"response":[{"id":"2ba053f9-fc98-40b9-8920-256a0c34969e","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"}]}},"response":[{"id":"361c78f8-45a7-435d-a71e-184a441bdc5d","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"BearerTask dependencies and dependents are essential to ensuring logical workflows within the Render platform.
\nBy defining relationships between tasks, they establish a structured sequence of actions, enabling efficient project and construction management while minimizing delays.
\nTask Types
\nEngineering, Planning, and Governance
\nThese tasks ensure the project complies with regulations and is executed according to approved designs.
\nCivil & Electrical Construction
\nInvolves groundwork and preparation to support network infrastructure.
\nAerial Infrastructure Deployment
\nInvolves stringing fiber across utility poles.
\nUnderground Fiber Deployment
\nHandles below-ground network fiber installs.
\nDistribution Devices and Splicing
\nTasks related to connecting and managing network segments.
\nRectification, Change, and QA Follow-up
\nHandle corrections and post-deployment issues.
\nTask Dependencies
\nDependencies represent prerequisite tasks that must be completed before another task can begin.
\nFor example, if Task B depends on Task A, Task B cannot start until Task A is completed.
\nA task may have zero, one, or multiple dependencies.
\nTasks with incomplete dependencies are blocked from being released until all prerequisite tasks are completed.
\nTask Dependents
\nDependents are tasks that cannot proceed until another task is completed.
\nFor example, Task C cannot start until Task B is finished.
\nA task may have zero, one, or multiple dependent tasks.
\nDependents represent downstream tasks waiting for a specific task to finish.
\nExamples
\n3 Step Example: Constructing a Fiber Optic Splice Enclosure
\nTask A: Install the Splice Enclosure Mount
\nSecure the enclosure mount to the designated pole or underground location.
\nDependency: None
\nTask B: Splice the Fiber Optic Cables
\nConnect and splice the fiber cables within the enclosure according to network design.
\nDependency: Task A (Enclosure mount installation) must be completed to provide a stable base.
\nTask C: Seal and Test the Enclosure
\nClose the enclosure, seal it to protect against environmental conditions, and test for signal integrity.
\nDependency: Task B (Fiber splicing) must be completed to ensure all connections are properly made.
\nPython Example
\nhttps://developer.rendernetworks.com/task-dependencies-and-dependents
\nimport logging\nimport sys\nimport requests\n# Please refer to \"Getting Started with Render API\" section @ https://developer.rendernetworks.com/\nPROJECT_SHORT_NAME = \"<Project Short Name>\"\nCLIENT_ID = \"<Client ID>\"\nCLIENT_SECRET = \"<Client Secret>\"\nAUTH_DOMAIN = \"<Auth Domain>\"\nAPI_ENDPOINT_DOMAIN = \"<API Endpoint Domain>\"\nCONTENT_TYPE = \"application/json\"\nPROJECT_TASK_ID = \"<Project Task ID to update>\"\ndef get_access_token(auth_domain, client_id, client_secret):\n \"\"\"\n Generate access token by given client id and secret.\n The access token is used as bearer token for accessing the backend api endpoints\n \"\"\"\n token_provider_endpoint = f\"https://{auth_domain}/oauth2/default/v1/token\"\n headers = {\"accept\": CONTENT_TYPE, \"cache-control\": \"no-cache\", \"content-type\": \"application/x-www-form-urlencoded\"}\n data = {\"grant_type\": \"client_credentials\", \"scope\": \"customScope\"}\n response = requests.post(\n url=token_provider_endpoint, auth=(client_id, client_secret), headers=headers, data=data, timeout=10\n )\n return response.json()[\"access_token\"]\nif __name__ == \"__main__\":\n logger = logging.getLogger()\n consoleHandler = logging.StreamHandler(sys.stdout)\n logger.addHandler(consoleHandler)\n logger.setLevel(logging.INFO)\n # Generate session token\n session_token = get_access_token(AUTH_DOMAIN, CLIENT_ID, CLIENT_SECRET)\n logger.info(f\"Session token: {session_token}\")\n headers = {\"Accept\": CONTENT_TYPE, \"Authorization\": f\"Bearer {session_token}\"}\n base_url = f\"https://{API_ENDPOINT_DOMAIN}/projects/{PROJECT_SHORT_NAME}/tasks/{PROJECT_TASK_ID}\"\n # Get Task Dependencies\n logger.info(\"Getting Task Dependencies ................ \")\n task_dependencies_endpoint = f\"{base_url}/dependencies?page=1&page_limit=500\"\n dependencies_response = requests.get(url=task_dependencies_endpoint, headers=headers, timeout=10)\n logger.info(f\"Task Dependencies Response: {dependencies_response.json()}\")\n\nGet specific details of a task type within a project providing scope into endpoint services and contextual form schema defined by task type.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","task_types",":task_type_name"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[{"id":"539b1234-6333-42bc-b339-dbc0eea9a340","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"},{"id":"f6d512a7-3002-4480-98b4-af5bd1358db4","description":{"content":"(Required) (Required)
\n","type":"text/plain"},"type":"any","value":"install_pole","key":"task_type_name"}]}},"response":[{"id":"bdfc70f3-fbb9-4cb4-b11a-4528bcafae7b","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerSpecifed task type within a project providing scope into endpoint services and contextual form schema.
\n","_postman_id":"3011500f-2ec1-483a-97d8-3e1b796da95f","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}}},{"name":"Get Task Types","id":"f45fad43-7fc9-4fa8-a13a-68130d4248d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.test.rendernetworks.com/projects/:project_short_name/task_types?page=1&page_limit=500&form_schema=true","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name","task_types"],"host":["api","test","rendernetworks","com"],"query":[{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"page_limit","value":"500"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"form_schema","value":"true"}],"variable":[{"id":"3744914c-c577-496d-8730-700047be83bd","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"}]}},"response":[{"id":"00ad9f71-f45f-4d6f-9242-86a2611d25e9","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerEvery Task has a type - Task Type.
\nEvery Task Type prescribes a Form (Schema) that the tasks of that type need to use for data collection during task completion. Over time, the Form schema for a task type can change. Thus, Forms are versioned. Thus, for a Task Type, there can be multiple versions of the Form (schema).
\nWhen a Task is blueprinted (created), it is assigned a Task Type. Which then dictates the Form (Schema) that will be used for data collection during the task completion. The latest version of the Form (Schema) for that Task Type is used.
\nThe Form Data (collected during the completion of tasks) is related to each task along with the Form Schema version that was used for that task.
\nExample:
\nA project has Task Type 'install_fiber' with a Form schema (v1)
\nA task (ID 7890) is blueprinted of task type 'install_fiber'
\nTask 78910 is completed - thus collecting data according to the From schema v1 of task type 'install_fiber'
\nDue to business requirements, modification is made to the Form schema of Task Type 'install_fiber' (thus introducing a new version v2)
\nA task (ID 2345) is blueprinted of task type 'install_fiber'
\nTask 2345 is completed - thus collecting data according to the From schema v2 of task type 'install_fiber'
\nThe result is:
\nTask ID 7890 has 'Form Data', which follows the v1 of Form schema for task type 'install_fiber'
\nTask ID 2345 has 'Form Data', which follows the v2 of Form schema for task type 'install_fiber'
\nThus, in an AsBuilt Report, which is essentially a list of completed tasks with associated form data, Form field names (for tasks) can be different based on the task type and the form schema version used for the task.
\nIn Render Customer API,
\nTask Type endpoints provide the From Schemas related to each task type.
\nTask endpoints provide the Form Data (for completed tasks) along with Task Type and the Form Schema version that was used for data collection during task completion.
\n","_postman_id":"d6cab086-a7d6-4a84-a2ac-44ec70e897a7","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}}},{"name":"Get Project","id":"2b6e0c90-5b2d-4130-9038-0578297e00be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.test.rendernetworks.com/projects/:project_short_name","description":"Get the details of a specified project.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects",":project_short_name"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[{"id":"ea83ff46-b752-403b-b8f5-a6b33a4b7eac","description":{"content":"(Required)
\n","type":"text/plain"},"type":"any","value":"BLKISL","key":"project_short_name"}]}},"response":[{"id":"0f4e2367-dcd1-4bb7-9d45-5076a07ed856","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerRelationships: Tasks, Task Types, Forms
\nEvery Task has a type - Task Type.
\nEvery Task Type prescribes a Form (Schema) that the tasks of that type need to use for data collection during task completion. Over time, the Form schema for a task type can change. Thus, Forms are versioned. Thus, for a Task Type, there can be multiple versions of the Form (schema).
\nWhen a Task is blueprinted (created), it is assigned a Task Type. Which then dictates the Form (Schema) that will be used for data collection during the task completion. The latest version of the Form (Schema) for that Task Type is used.
\nThe Form Data (collected during the completion of tasks) is related to each task along with the Form Schema version that was used for that task.
\nExample:
\nA project has Task Type 'install_fiber' with a Form schema (v1)
\nA task (ID 7890) is blueprinted of task type 'install_fiber'
\nTask 78910 is completed - thus collecting data according to the From schema v1 of task type 'install_fiber'
\nDue to business requirements, modification is made to the Form schema of Task Type 'install_fiber' (thus introducing a new version v2)
\nA task (ID 2345) is blueprinted of task type 'install_fiber'
\nTask 2345 is completed - thus collecting data according to the From schema v2 of task type 'install_fiber'
\nThe result is:
\nTask ID 7890 has 'Form Data', which follows the v1 of Form schema for task type 'install_fiber'
\nTask ID 2345 has 'Form Data', which follows the v2 of Form schema for task type 'install_fiber'
\nThus, in an AsBuilt Report, which is essentially a list of completed tasks with associated form data, Form field names (for tasks) can be different based on the task type and the form schema version used for the task.
\nIn Render Customer API,
\nTask Type endpoints provide the From Schemas related to each task type.
\nTask endpoints provide the Form Data (for completed tasks) along with Task Type and the Form Schema version that was used for data collection during task completion.
\n","_postman_id":"2d65f101-020e-42d9-aabc-7058188550c5","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}}},{"name":"Get Projects","id":"6bb993ee-a40c-4a55-88b5-b5d9c0fa8d41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.test.rendernetworks.com/projects?page=1&page_limit=100","description":"Get a list of all projects scoped to an organization's account. This will reveal the project_short_name's used in endpoint path's in dialogue interacting with a project.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["projects"],"host":["api","test","rendernetworks","com"],"query":[{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"(Required)
\n","type":"text/plain"},"key":"page_limit","value":"100"}],"variable":[]}},"response":[{"id":"9160e9d1-07bf-4c43-8054-c3c5d5c8c970","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"BearerRender Task Types
\nIn Render Networks’ fiber construction platform, task types represent discrete units of work aligned to network build milestones. Understanding each task’s role helps track construction progress and coordinate timely financial operations, such as capitalizing assets in progress, paying vendor invoices, and managing funding drawdowns.
\nBelow is a breakdown of the 20 task types, grouped and explained by functional category, followed by how each supports situational awareness and financial support during a network build:
\nEngineering, Planning, and Governance
\nThese tasks ensure the project complies with regulations and is executed according to approved designs.
\nCivil & Electrical Construction
\nInvolves groundwork and preparation to support network infrastructure.
\nAerial Infrastructure Deployment
\nInvolves stringing fiber across utility poles.
\nUnderground Fiber Deployment
\nHandles below-ground network fiber installs.
\nDistribution Devices and Splicing
\nTasks related to connecting and managing network segments.
\nRectification, Change, and QA Follow-up
\nHandle corrections and post-deployment issues.
\nRender Task Type to Fixed Asset Mapping
\nComplete Python Example
\n'''\nRender Networks - Get projects, and then get tasks from first project returned\n'''\nimport requests\nimport json\n# Please fill in the below fields with the information you recieved \n# when you signed up for an API account\nAUTH_DOMAIN = '<YOUR AUTH DOMAIN>'\nCLIENT_ID = '<YOUR CLIENT ID>'\nCLIENT_SECRET = '<YOUR CLIENT SECRET>'\nAPI_ENDPOINT_DOMAIN = '<YOUR API DOMAIN>'\n# Don't alter anything below this line\ndef get_access_token(AUTH_DOMAIN, CLIENT_ID, CLIENT_SECRET):\n \"\"\"\n Generate access token by given client id and secret.\n The access token is used as bearer token for accessing the backend api endpoints\n \"\"\"\n token_uri = f\"{AUTH_DOMAIN}/oauth2/default/v1/token\"\n headers = {\n 'accept': 'application/json',\n 'cache-control': 'no-cache',\n 'content-type': 'application/x-www-form-urlencoded'\n }\n data = {\n 'grant_type': 'client_credentials', \n 'scope': 'customScope',\n }\n resp = requests.post(token_uri, auth=(CLIENT_ID, CLIENT_SECRET), headers=headers, data=data)\n return resp.json()['access_token']\ndef get_projects(access_token, API_ENDPOINT_DOMAIN):\n \"\"\"\n Get a list of projects\n \"\"\"\n render_url = f\"https://{API_ENDPOINT_DOMAIN}/projects/?page=1&page_limit=100\"\n headers = {\n 'Accept': 'application/json',\n 'Authorization': f\"Bearer {access_token}\",\n }\n return requests.get(render_url, headers=headers)\ndef get_tasks(access_token, API_ENDPOINT_DOMAIN, project_short_name):\n \"\"\"\n get task list by given project short name\n \"\"\"\n render_url = f\"https://{API_ENDPOINT_DOMAIN}/projects/{project_short_name}/tasks/?page=1&page_limit=100\"\n headers = {\n 'Accept': 'application/json',\n 'Authorization': f\"Bearer {access_token}\",\n }\n return requests.get(render_url, headers=headers)\nif __name__ == '__main__':\n # Retrieve access token \n access_token = get_access_token(AUTH_DOMAIN, CLIENT_ID, CLIENT_SECRET)\n print(f\"{access_token}\\n\")\n # Get all accessible projects\n resp = get_projects(access_token, API_ENDPOINT_DOMAIN)\n print(\"Response Code: \", resp.status_code)\n print(\"Response Body: \", resp.text)\n # Get the first project from the list, then retrieve the tasks under project\n projects = json.loads(resp.text)['data']\n prj_short_name = projects[0]['short_name']\n print(\"First Project Short Name: \", prj_short_name)\n print(json.dumps(projects, indent=4))\n #Get tasks from first project\n tasks_resp = get_tasks(access_token, API_ENDPOINT_DOMAIN, prj_short_name)\n tasks = json.loads(tasks_resp.text)['data']\n print(\"Response Code: \", tasks_resp.status_code)\n print(json.dumps(tasks, indent=4))\n\nhttps://developer.rendernetworks.com/get-projects-and-tasks
\n","_postman_id":"3d02d028-8100-4d81-8191-5151da6ceb82","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}}},{"name":"ping","item":[{"name":"/","id":"054ed654-87b5-4bb4-8f30-0c1420d1992b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.test.rendernetworks.com/ping","description":"Endpoint to test the API connectivity
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}},"urlObject":{"protocol":"https","path":["ping"],"host":["api","test","rendernetworks","com"],"query":[],"variable":[]}},"response":[{"id":"02906970-39b3-4791-9186-1dc7522fd4db","name":"200 OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerIn a cloud-native environment, the /ping endpoint is commonly used as a lightweight health check for service availability and responsiveness. Here's how it fits into the broader architecture and how to implement and use it effectively.
Purpose
\nThe /ping endpoint is designed to:
- \n
Respond quickly and simply (e.g., 200 OK with \"pong\")
\n \nVerify that the service is alive and responding to HTTP requests
\n \nAct as a health signal for:
\n- \n
Load balancers
\n \nOrchestrators (like Kubernetes)
\n \nMonitoring systems
\n \n
\n
Expectation
\nA typical /ping endpoint:
GET /ping\n→ 200 OK\n→ Body: \"pong\" (optional)\n\nKubernetes
\n- \n
Liveness probe: Restarts the container if
\n/pingdoesn't respond \nReadiness probe: Determines if traffic can be routed to the container
\n \n
livenessProbe:\n httpGet:\n path: /ping\n port: 8080\n initialDelaySeconds: 5\n periodSeconds: 10\n timeoutSeconds: 1\n\nLoad Balancers
\nSet the health check URL to /ping. Example:
- \n
Protocol: HTTP
\n \nPath:
\n/ping\nSuccess codes:
\n200\nTimeout: 5s
\n \nInterval: 30s
\n \n
This ensures:
\n- \n
Healthy instances receive traffic
\n \nUnhealthy ones are pulled from rotation
\n \n
Service Meshes
\nService meshes can route and restart services based on health check behavior. /ping is used as a sidecar check.
Monitoring & Alerting
\n- \n
Latency
\n \nAvailability
\n \nError rates
\n \n
- alert: ServiceDown\n expr: probe_success{job=\"myservice-ping\"} == 0\n for: 2m\n labels:\n severity: critical\n\nBest Practice Review
\n/ping provides a shallow health check for systems integration.
\n","_postman_id":"0399ed53-e7b1-428f-bd6d-dcdd3cff5995","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"85259170-35ba-48bb-8761-e5b8a5a637f0","id":"85259170-35ba-48bb-8761-e5b8a5a637f0","name":"render-customer-api","type":"collection"}}},{"name":"token","item":[{"name":"Token","id":"1bcdc8a7-4eb9-4d8a-bb4b-2790e17b9603","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{basicAuthUsername}}"},{"key":"password","value":"{{basicAuthPassword}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"description":"(Required)
\n","key":"grant_type","value":"client_credentials"},{"description":"(Required)
\n","key":"scope","value":"customScope"}]},"url":"https://rendernetworks-dev-4010329.okta.com/oauth2/default/v1/token","urlObject":{"protocol":"https","path":["oauth2","default","v1","token"],"host":["rendernetworks-dev-4010329","okta","com"],"query":[],"variable":[]}},"response":[{"id":"a8272825-1b3c-4b16-adfa-734f0971dc7b","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"BasicAuthenticaing
\nhttps://developer.rendernetworks.com/how-to-request-client-id-and-client-secret
\nSetup
\nTo access the Render Networks API, you must acquire a set of API credentials comprising a Client ID and a Client Secret from our platform. To generate these credentials, an Organization Administrator of your Render account should follow these steps within the Account Admin section of the Render platform:
\n- \n
Navigate to the API Access page
\n \nClick on the 'Generate' button above the API credentials table
\n \nProvide a description for the application that requires access to the Render API
\n \nChoose the desired access level for the credentials: Read-Only or Read/Write
\n \nClick the 'Generate' button
\n \nThe newly generated API credentials 'Client ID' and 'Client Secret' will be displayed in the API Credentials table.
\n \nCopy the 'Client ID' and the associated hidden 'Client Secret' using the copy icon to copy the 'Client Secret' to your clipboard. You can subsequently paste these credentials wherever they are required.
\n \n
Python Usage
\n'''\nRender Networks - Generate JWT Example\n'''\nimport requests\n# Please fill in the below fields with the information you recieved \n# when you signed up for an API account\nAUTH_DOMAIN = '<YOUR AUTH DOMAIN>'\nCLIENT_ID = '<YOUR CLIENT ID>'\nCLIENT_SECRET = '<YOUR CLIENT SECRET>'\n# Don't alter anything below this line\ndef get_access_token(custom_domain, client_id, client_secret):\n token_uri = f\"{custom_domain}/oauth2/default/v1/token\"\n headers = {\n 'accept': 'application/json',\n 'cache-control': 'no-cache',\n 'content-type': 'application/x-www-form-urlencoded'\n }\n data = {\n 'grant_type': 'client_credentials', \n 'scope': 'customScope',\n }\n resp = requests.post(token_uri, auth=(client_id, client_secret), headers=headers, data=data)\n return resp.json()\nif __name__ == '__main__':\n response = get_access_token(AUTH_DOMAIN, CLIENT_ID, CLIENT_SECRET)\n print()\n for key in response:\n print(f'{key}: {response[key]}\\n')\n\n