{"items":[{"type":"link","label":"Trustgrid Management API","link":"/","routeSlug":"/","content":{"contentType":"overview","meta":{"name":"Trustgrid Management API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"unlicensed","url":"https://trustgrid.io"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Trustgrid Management API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Trustgrid Management API provides programmatic access to manage the Trustgrid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"network infrastructure platform. Trustgrid connects distributed nodes (appliances and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"agents) into secure overlay networks with centralized management."},"children":[]}]}]}]}],"sectionId":"/"}],"sectionId":"/"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/key-concepts"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Key Concepts"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nodes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The core compute units — either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (physical/VM appliance) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Agent"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(lightweight software agent on a device). Identified by UUID ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and FQDN."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clusters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": High-availability groups of nodes sharing configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domains"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Logical groupings of nodes within an organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual Networks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Layer-3 overlay networks ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DomainNetwork"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") created within a domain,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"enabling zero-trust connectivity between nodes. Each network has access policies,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS config, routes, and port forwarding rules."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Key-value metadata attached to nodes and clusters for grouping and permissions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shadow"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Each node has an AWS IoT Device Shadow with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (target config) and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (current state) halves. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" shadow contains telemetry using"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dot-notation keys (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nic.eth0.mtu"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-core.version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]}],"sectionId":"/section/key-concepts"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests require a JWT Bearer token in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"Authorization: Bearer <token>\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Authorization: Bearer <token>\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tokens are obtained via the Trustgrid portal or programmatically via service user"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"credentials. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API Access docs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/permissions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permissions"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most endpoints require specific permissions (noted in each endpoint's description)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permissions follow the pattern "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource::action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"sectionId":"/section/permissions"}]}]}},{"type":"link","label":"Key Concepts","link":"/section/key-concepts","routeSlug":"/section/key-concepts","content":null},{"type":"link","label":"Authentication","link":"/section/authentication","routeSlug":"/section/authentication","content":null},{"type":"link","label":"Permissions","link":"/section/permissions","routeSlug":"/section/permissions","content":null},{"type":"separator","label":"Alerts","content":null},{"type":"group","label":"Alarm","link":"/alarm","routeSlug":"/alarm","items":[{"label":"Retrieve all configured alarm filters and their trigger conditions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/listalarms","routeSlug":"/alarm/listalarms","metadata":{"seo":{"title":"Retrieve all configured alarm filters and their trigger conditions","description":"Requires alarms::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAlarms","name":"Retrieve all configured alarm filters and their trigger conditions","isWebhook":false,"pointer":"/paths/~1v2~1alarm/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all configured alarm filters and their trigger conditions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alarms::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/alarm","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alarm","href":"/alarm/listalarms","openApiOperationId":"listAlarms","summary":"Retrieve all configured alarm filters and their trigger conditions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_238"}},"schemaId":"schema_238"}],"pointer":"/paths/~1v2~1alarm/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_238","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_238"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/listalarms"}],"panels":[]}]},"httpPath":"/v2/alarm"},{"label":"Create a new alarm filter to monitor events and trigger notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/paths/~1v2~1alarm/post","routeSlug":"/alarm/paths/~1v2~1alarm/post","metadata":{"seo":{"title":"Create a new alarm filter to monitor events and trigger notifications","description":"Requires alarms::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new alarm filter to monitor events and trigger notifications","isWebhook":false,"pointer":"/paths/~1v2~1alarm/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new alarm filter to monitor events and trigger notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alarms::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlarmModel"}},"schemaId":"components/schemas/AlarmModel","pointer":"/paths/~1v2~1alarm/post/requestBody","description":"Alarm body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/alarm","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlarmModel"}},"responseCodes":["200","422"],"pointer":"/v2/alarm","href":"/alarm/paths/~1v2~1alarm/post","summary":"Create a new alarm filter to monitor events and trigger notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/AlarmModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlarmModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1alarm/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/paths/~1v2~1alarm/post"}],"panels":[]}]},"httpPath":"/v2/alarm"},{"label":"Retrieve all configured notification channels for alarm delivery","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/listalarmchannels","routeSlug":"/alarm/listalarmchannels","metadata":{"seo":{"title":"Retrieve all configured notification channels for alarm delivery","description":"Retrieve all configured notification channels for alarm delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAlarmChannels","name":"Retrieve all configured notification channels for alarm delivery","isWebhook":false,"pointer":"/paths/~1v2~1alarm-channel/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all configured notification channels for alarm delivery","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/alarm-channel","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alarm-channel","href":"/alarm/listalarmchannels","openApiOperationId":"listAlarmChannels","summary":"Retrieve all configured notification channels for alarm delivery"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239"}},"schemaId":"schema_239"}],"pointer":"/paths/~1v2~1alarm-channel/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_239","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_239"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/listalarmchannels"}],"panels":[]}]},"httpPath":"/v2/alarm-channel"},{"label":"Configure a new notification channel for alarm delivery (email, Slack, etc.)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/paths/~1v2~1alarm-channel/post","routeSlug":"/alarm/paths/~1v2~1alarm-channel/post","metadata":{"seo":{"title":"Configure a new notification channel for alarm delivery (email, Slack, etc.)","description":"Configure a new notification channel for alarm delivery (email, Slack, etc.)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure a new notification channel for alarm delivery (email, Slack, etc.)","isWebhook":false,"pointer":"/paths/~1v2~1alarm-channel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure a new notification channel for alarm delivery (email, Slack, etc.)","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlarmChannelModel"}},"schemaId":"components/schemas/AlarmChannelModel","pointer":"/paths/~1v2~1alarm-channel/post/requestBody","description":"Alarm channel body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/alarm-channel","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlarmChannelModel"}},"responseCodes":["200","422"],"pointer":"/v2/alarm-channel","href":"/alarm/paths/~1v2~1alarm-channel/post","summary":"Configure a new notification channel for alarm delivery (email, Slack, etc.)"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/AlarmChannelModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlarmChannelModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1alarm-channel/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/paths/~1v2~1alarm-channel/post"}],"panels":[]}]},"httpPath":"/v2/alarm-channel"},{"label":"Permanently remove a notification channel configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/paths/~1v2~1alarm-channel~1{uid}/delete","routeSlug":"/alarm/paths/~1v2~1alarm-channel~1{uid}/delete","metadata":{"seo":{"title":"Permanently remove a notification channel configuration","description":"Permanently remove a notification channel configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Permanently remove a notification channel configuration","isWebhook":false,"pointer":"/paths/~1v2~1alarm-channel~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permanently remove a notification channel configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1v2~1alarm-channel~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/alarm-channel/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alarm-channel/{uid}","href":"/alarm/paths/~1v2~1alarm-channel~1{uid}/delete","summary":"Permanently remove a notification channel configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1alarm-channel~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/paths/~1v2~1alarm-channel~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/alarm-channel/{uid}"},{"label":"Retrieve configuration details for a specific notification channel","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/getalarmchannel","routeSlug":"/alarm/getalarmchannel","metadata":{"seo":{"title":"Retrieve configuration details for a specific notification channel","description":"Retrieve configuration details for a specific notification channel"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlarmChannel","name":"Retrieve configuration details for a specific notification channel","isWebhook":false,"pointer":"/paths/~1v2~1alarm-channel~1{uid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve configuration details for a specific notification channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1v2~1alarm-channel~1{uid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/alarm-channel/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alarm-channel/{uid}","href":"/alarm/getalarmchannel","openApiOperationId":"getAlarmChannel","summary":"Retrieve configuration details for a specific notification channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmChannelModel"}},"schemaId":"components/schemas/AlarmChannelModel"}],"pointer":"/paths/~1v2~1alarm-channel~1{uid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlarmChannelModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmChannelModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/getalarmchannel"}],"panels":[]}]},"httpPath":"/v2/alarm-channel/{uid}"},{"label":"Modify settings for an existing notification channel","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/paths/~1v2~1alarm-channel~1{uid}/put","routeSlug":"/alarm/paths/~1v2~1alarm-channel~1{uid}/put","metadata":{"seo":{"title":"Modify settings for an existing notification channel","description":"Modify settings for an existing notification channel"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify settings for an existing notification channel","isWebhook":false,"pointer":"/paths/~1v2~1alarm-channel~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify settings for an existing notification channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1v2~1alarm-channel~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlarmChannelModel"}},"schemaId":"components/schemas/AlarmChannelModel","pointer":"/paths/~1v2~1alarm-channel~1{uid}/put/requestBody","description":"Alarm channel body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/alarm-channel/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlarmChannelModel"}},"responseCodes":["200","422"],"pointer":"/v2/alarm-channel/{uid}","href":"/alarm/paths/~1v2~1alarm-channel~1{uid}/put","summary":"Modify settings for an existing notification channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/AlarmChannelModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlarmChannelModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1alarm-channel~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/paths/~1v2~1alarm-channel~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/alarm-channel/{uid}"},{"label":"Cancel an active alert suppression window and resume normal notifications","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/paths/~1v2~1alarm~1suppression/delete","routeSlug":"/alarm/paths/~1v2~1alarm~1suppression/delete","metadata":{"seo":{"title":"Cancel an active alert suppression window and resume normal notifications","description":"Cancel an active alert suppression window and resume normal notifications"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Cancel an active alert suppression window and resume normal notifications","isWebhook":false,"pointer":"/paths/~1v2~1alarm~1suppression/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel an active alert suppression window and resume normal notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/alarm/suppression","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alarm/suppression","href":"/alarm/paths/~1v2~1alarm~1suppression/delete","summary":"Cancel an active alert suppression window and resume normal notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1alarm~1suppression/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/paths/~1v2~1alarm~1suppression/delete"}],"panels":[]}]},"httpPath":"/v2/alarm/suppression"},{"label":"Retrieve current or upcoming alert suppression schedule details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/getalarmsuppression","routeSlug":"/alarm/getalarmsuppression","metadata":{"seo":{"title":"Retrieve current or upcoming alert suppression schedule details","description":"Retrieve current or upcoming alert suppression schedule details"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlarmSuppression","name":"Retrieve current or upcoming alert suppression schedule details","isWebhook":false,"pointer":"/paths/~1v2~1alarm~1suppression/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve current or upcoming alert suppression schedule details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/alarm/suppression","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alarm/suppression","href":"/alarm/getalarmsuppression","openApiOperationId":"getAlarmSuppression","summary":"Retrieve current or upcoming alert suppression schedule details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertSuppressionModel"}},"schemaId":"components/schemas/AlertSuppressionModel"}],"pointer":"/paths/~1v2~1alarm~1suppression/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlertSuppressionModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlertSuppressionModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/getalarmsuppression"}],"panels":[]}]},"httpPath":"/v2/alarm/suppression"},{"label":"Schedule a time period to temporarily disable alarm notifications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/paths/~1v2~1alarm~1suppression/post","routeSlug":"/alarm/paths/~1v2~1alarm~1suppression/post","metadata":{"seo":{"title":"Schedule a time period to temporarily disable alarm notifications","description":"Schedule a time period to temporarily disable alarm notifications"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Schedule a time period to temporarily disable alarm notifications","isWebhook":false,"pointer":"/paths/~1v2~1alarm~1suppression/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedule a time period to temporarily disable alarm notifications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertSuppressionModel"}},"schemaId":"components/schemas/AlertSuppressionModel","pointer":"/paths/~1v2~1alarm~1suppression/post/requestBody","description":"Alarm channel body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/alarm/suppression","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlertSuppressionModel"}},"responseCodes":["200","422"],"pointer":"/v2/alarm/suppression","href":"/alarm/paths/~1v2~1alarm~1suppression/post","summary":"Schedule a time period to temporarily disable alarm notifications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/AlertSuppressionModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlertSuppressionModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1alarm~1suppression/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/paths/~1v2~1alarm~1suppression/post"}],"panels":[]}]},"httpPath":"/v2/alarm/suppression"},{"label":"Permanently remove an alarm filter and stop monitoring conditions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/paths/~1v2~1alarm~1{uid}/delete","routeSlug":"/alarm/paths/~1v2~1alarm~1{uid}/delete","metadata":{"seo":{"title":"Permanently remove an alarm filter and stop monitoring conditions","description":"Permanently remove an alarm filter and stop monitoring conditions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Permanently remove an alarm filter and stop monitoring conditions","isWebhook":false,"pointer":"/paths/~1v2~1alarm~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permanently remove an alarm filter and stop monitoring conditions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1v2~1alarm~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/alarm/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alarm/{uid}","href":"/alarm/paths/~1v2~1alarm~1{uid}/delete","summary":"Permanently remove an alarm filter and stop monitoring conditions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1alarm~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/paths/~1v2~1alarm~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/alarm/{uid}"},{"label":"Retrieve detailed configuration of a specific alarm filter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/getalarm","routeSlug":"/alarm/getalarm","metadata":{"seo":{"title":"Retrieve detailed configuration of a specific alarm filter","description":"Retrieve detailed configuration of a specific alarm filter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAlarm","name":"Retrieve detailed configuration of a specific alarm filter","isWebhook":false,"pointer":"/paths/~1v2~1alarm~1{uid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed configuration of a specific alarm filter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1v2~1alarm~1{uid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/alarm/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alarm/{uid}","href":"/alarm/getalarm","openApiOperationId":"getAlarm","summary":"Retrieve detailed configuration of a specific alarm filter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmModel"}},"schemaId":"components/schemas/AlarmModel"}],"pointer":"/paths/~1v2~1alarm~1{uid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/AlarmModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AlarmModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/getalarm"}],"panels":[]}]},"httpPath":"/v2/alarm/{uid}"},{"label":"Modify trigger conditions and settings for an existing alarm filter","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alarm/paths/~1v2~1alarm~1{uid}/put","routeSlug":"/alarm/paths/~1v2~1alarm~1{uid}/put","metadata":{"seo":{"title":"Modify trigger conditions and settings for an existing alarm filter","description":"Modify trigger conditions and settings for an existing alarm filter"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify trigger conditions and settings for an existing alarm filter","isWebhook":false,"pointer":"/paths/~1v2~1alarm~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify trigger conditions and settings for an existing alarm filter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1v2~1alarm~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlarmModel"}},"schemaId":"components/schemas/AlarmModel","pointer":"/paths/~1v2~1alarm~1{uid}/put/requestBody","description":"Alarm body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/alarm/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AlarmModel"}},"responseCodes":["200","422"],"pointer":"/v2/alarm/{uid}","href":"/alarm/paths/~1v2~1alarm~1{uid}/put","summary":"Modify trigger conditions and settings for an existing alarm filter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/AlarmModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AlarmModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1alarm~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alarm/paths/~1v2~1alarm~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/alarm/{uid}"}],"content":{"contentType":"group","meta":{"name":"Alarm"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alarm","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/alarms/alarm-filters/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alarm filters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" define criteria and thresholds for when events generate alert notifications. Configure alert channels (email, Slack, PagerDuty, OpsGenie, Teams, webhooks) and maintenance windows. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alarms::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/alarm","summary":"Retrieve all configured alarm filters and their trigger conditions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alarm/listalarms","deprecated":false},{"title":"/v2/alarm","summary":"Create a new alarm filter to monitor events and trigger notifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alarm/paths/~1v2~1alarm/post","deprecated":false},{"title":"/v2/alarm-channel","summary":"Retrieve all configured notification channels for alarm delivery","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alarm/listalarmchannels","deprecated":false},{"title":"/v2/alarm-channel","summary":"Configure a new notification channel for alarm delivery (email, Slack, etc.)","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alarm/paths/~1v2~1alarm-channel/post","deprecated":false},{"title":"/v2/alarm-channel/{uid}","summary":"Permanently remove a notification channel configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alarm/paths/~1v2~1alarm-channel~1{uid}/delete","deprecated":false},{"title":"/v2/alarm-channel/{uid}","summary":"Retrieve configuration details for a specific notification channel","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alarm/getalarmchannel","deprecated":false},{"title":"/v2/alarm-channel/{uid}","summary":"Modify settings for an existing notification channel","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alarm/paths/~1v2~1alarm-channel~1{uid}/put","deprecated":false},{"title":"/v2/alarm/suppression","summary":"Cancel an active alert suppression window and resume normal notifications","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alarm/paths/~1v2~1alarm~1suppression/delete","deprecated":false},{"title":"/v2/alarm/suppression","summary":"Retrieve current or upcoming alert suppression schedule details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alarm/getalarmsuppression","deprecated":false},{"title":"/v2/alarm/suppression","summary":"Schedule a time period to temporarily disable alarm notifications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alarm/paths/~1v2~1alarm~1suppression/post","deprecated":false},{"title":"/v2/alarm/{uid}","summary":"Permanently remove an alarm filter and stop monitoring conditions","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alarm/paths/~1v2~1alarm~1{uid}/delete","deprecated":false},{"title":"/v2/alarm/{uid}","summary":"Retrieve detailed configuration of a specific alarm filter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alarm/getalarm","deprecated":false},{"title":"/v2/alarm/{uid}","summary":"Modify trigger conditions and settings for an existing alarm filter","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alarm/paths/~1v2~1alarm~1{uid}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Alert","link":"/alert","routeSlug":"/alert","items":[{"label":"Retrieve security and operational events for a specific node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alert/listnodealerts","routeSlug":"/alert/listnodealerts","metadata":{"seo":{"title":"Retrieve security and operational events for a specific node","description":"List events for a node (appliance or agent), newest first"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeAlerts","name":"Retrieve security and operational events for a specific node","isWebhook":false,"pointer":"/paths/~1alert~1{nodeID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve security and operational events for a specific node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List events for a node (appliance or agent), newest first"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alerts::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1alert~1{nodeID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/alert/{nodeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/alert/{nodeID}","href":"/alert/listnodealerts","openApiOperationId":"listNodeAlerts","summary":"Retrieve security and operational events for a specific node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_241"}},"schemaId":"schema_241"}],"pointer":"/paths/~1alert~1{nodeID}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_241","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_241"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/listnodealerts"}],"panels":[]}]},"httpPath":"/alert/{nodeID}"},{"label":"Retrieve all recent security and operational alerts across the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alert/listalertsv2","routeSlug":"/alert/listalertsv2","metadata":{"seo":{"title":"Retrieve all recent security and operational alerts across the organization","description":"Requires alerts::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAlertsV2","name":"Retrieve all recent security and operational alerts across the organization","isWebhook":false,"pointer":"/paths/~1v2~1alert/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all recent security and operational alerts across the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alerts::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/alert","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alert","href":"/alert/listalertsv2","openApiOperationId":"listAlertsV2","summary":"Retrieve all recent security and operational alerts across the organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_242"}},"schemaId":"schema_242"}],"pointer":"/paths/~1v2~1alert/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_242","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_242"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/listalertsv2"}],"panels":[]}]},"httpPath":"/v2/alert"},{"label":"Retrieve security and operational alerts specific to a single node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alert/listnodealertsv2","routeSlug":"/alert/listnodealertsv2","metadata":{"seo":{"title":"Retrieve security and operational alerts specific to a single node","description":"Requires alerts::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeAlertsV2","name":"Retrieve security and operational alerts specific to a single node","isWebhook":false,"pointer":"/paths/~1v2~1alert~1{nodeID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve security and operational alerts specific to a single node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alerts::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1alert~1{nodeID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/alert/{nodeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alert/{nodeID}","href":"/alert/listnodealertsv2","openApiOperationId":"listNodeAlertsV2","summary":"Retrieve security and operational alerts specific to a single node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_242"}},"schemaId":"schema_242"}],"pointer":"/paths/~1v2~1alert~1{nodeID}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_242","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_242"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/listnodealertsv2"}],"panels":[]}]},"httpPath":"/v2/alert/{nodeID}"},{"label":"Manually resolve and dismiss a specific alert type for a node","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alert/paths/~1v2~1alert~1{nodeid}~1{alerttype}/delete","routeSlug":"/alert/paths/~1v2~1alert~1{nodeid}~1{alerttype}/delete","metadata":{"seo":{"title":"Manually resolve and dismiss a specific alert type for a node","description":"Requires alerts::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Manually resolve and dismiss a specific alert type for a node","isWebhook":false,"pointer":"/paths/~1v2~1alert~1{nodeID}~1{alertType}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manually resolve and dismiss a specific alert type for a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alerts::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"alertType","in":"path","schemaId":"schema_240","description":"Alert type, eg Node Disconnect","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1alert~1{nodeID}~1{alertType}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/alert/{nodeID}/{alertType}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"alertType","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/alert/{nodeID}/{alertType}","href":"/alert/paths/~1v2~1alert~1{nodeid}~1{alerttype}/delete","summary":"Manually resolve and dismiss a specific alert type for a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1alert~1{nodeID}~1{alertType}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/paths/~1v2~1alert~1{nodeid}~1{alerttype}/delete"}],"panels":[]}]},"httpPath":"/v2/alert/{nodeID}/{alertType}"},{"label":"List audit events across the organization filtered by time range and type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alert/listevents","routeSlug":"/alert/listevents","metadata":{"seo":{"title":"List audit events across the organization filtered by time range and type","description":"Returns a paginated list of audit events (node connects/disconnects,config changes, certificate warnings, order updates, etc.) within atime window. Supports filtering by node, event type, level, and itemtype. Use sTime/eTime for the time range (ISO 8601)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEvents","name":"List audit events across the organization filtered by time range and type","isWebhook":false,"pointer":"/paths/~1v2~1event/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List audit events across the organization filtered by time range and type","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of audit events (node connects/disconnects,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"config changes, certificate warnings, order updates, etc.) within a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time window. Supports filtering by node, event type, level, and item"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"type. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the time range (ISO 8601)."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 datetime string for the start of the range (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-01-01T05:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"name":"eTime","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 datetime string for the end of the range (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-01-01T05:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"name":"nodeIDs","in":"query","schemaId":"schema_243","description":"Node IDs to filter events for (optional)"},{"name":"eventTypes","in":"query","schemaId":"schema_243","description":"Event type(s) filter (optional)"},{"name":"levels","in":"query","schemaId":"schema_244","description":"Event level(s) filter (optional)"},{"name":"itemTypes","in":"query","schemaId":"schema_245","description":"Item Type(s) filter (optional)"},{"name":"limit","in":"query","schemaId":"schema_246","description":"Maximum number of results to return"},{"name":"page","in":"query","schemaId":"schema_240","description":"Page of results to return"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results, like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level:desc or eventType:asc"},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_240","description":"Full text search of events"}],"pointer":"/paths/~1v2~1event/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/event","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"sTime","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"nodeIDs","in":"query","schemaId":"schema_243","style":"form","explode":false},{"name":"eventTypes","in":"query","schemaId":"schema_243","style":"form","explode":false},{"name":"levels","in":"query","schemaId":"schema_244","style":"form","explode":false},{"name":"itemTypes","in":"query","schemaId":"schema_245","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_246"},{"name":"page","in":"query","schemaId":"schema_240"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/event","href":"/alert/listevents","openApiOperationId":"listEvents","summary":"List audit events across the organization filtered by time range and type"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}},"schemaId":"schema_247","headers":{"x-total-count":{"description":"Total number of filtered events","schema":{"type":"number"}}},"headerSchemaId":"schema_248"}],"pointer":"/paths/~1v2~1event/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_247","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/listevents"}],"panels":[]}]},"httpPath":"/v2/event"},{"label":"Get all events by time range for a Node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alert/listnodeevents","routeSlug":"/alert/listnodeevents","metadata":{"seo":{"title":"Get all events by time range for a Node","description":"Requires events::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeEvents","name":"Get all events by time range for a Node","isWebhook":false,"pointer":"/paths/~1v2~1event~1{nodeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get all events by time range for a Node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"events::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeId","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1v2~1event~1{nodeId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 datetime string for the start of the range (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-01-01T05:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"name":"eTime","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 datetime string for the end of the range (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2025-01-01T05:00:00.000Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"name":"eventTypes","in":"query","schemaId":"schema_243","description":"Event type(s) filter (optional)"},{"name":"levels","in":"query","schemaId":"schema_244","description":"Event level(s) filter (optional)"},{"name":"limit","in":"query","schemaId":"schema_246","description":"Maximum number of results to return"},{"name":"page","in":"query","schemaId":"schema_240","description":"Page of results to return"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results, like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"level:desc or eventType:asc"},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_240","description":"Full text search of events"}],"pointer":"/paths/~1v2~1event~1{nodeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/event/{nodeId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeId","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"sTime","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"eventTypes","in":"query","schemaId":"schema_243","style":"form","explode":false},{"name":"levels","in":"query","schemaId":"schema_244","style":"form","explode":false},{"name":"limit","in":"query","schemaId":"schema_246"},{"name":"page","in":"query","schemaId":"schema_240"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/event/{nodeId}","href":"/alert/listnodeevents","openApiOperationId":"listNodeEvents","summary":"Get all events by time range for a Node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}},"schemaId":"schema_247","headers":{"x-total-count":{"description":"Total number of filtered node events","schema":{"type":"number"}}},"headerSchemaId":"schema_249"}],"pointer":"/paths/~1v2~1event~1{nodeId}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_247","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_247"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/listnodeevents"}],"panels":[]}]},"httpPath":"/v2/event/{nodeId}"},{"label":"Validate if a specific event would trigger configured alarm filters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alert/paths/~1v2~1event~1{nodeid}~1{eventid}/post","routeSlug":"/alert/paths/~1v2~1event~1{nodeid}~1{eventid}/post","metadata":{"seo":{"title":"Validate if a specific event would trigger configured alarm filters","description":"Validate if a specific event would trigger configured alarm filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Validate if a specific event would trigger configured alarm filters","isWebhook":false,"pointer":"/paths/~1v2~1event~1{nodeId}~1{eventId}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate if a specific event would trigger configured alarm filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeId","in":"path","schemaId":"schema_240","required":true},{"name":"eventId","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1v2~1event~1{nodeId}~1{eventId}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/event/{nodeId}/{eventId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeId","in":"path","required":true,"schemaId":"schema_240"},{"name":"eventId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/event/{nodeId}/{eventId}","href":"/alert/paths/~1v2~1event~1{nodeid}~1{eventid}/post","summary":"Validate if a specific event would trigger configured alarm filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1event~1{nodeId}~1{eventId}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/paths/~1v2~1event~1{nodeid}~1{eventid}/post"}],"panels":[]}]},"httpPath":"/v2/event/{nodeId}/{eventId}"},{"label":"List all security and operational events across the organization","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/alert/listalerts","routeSlug":"/alert/listalerts","metadata":{"seo":{"title":"List all security and operational events across the organization","description":"This is deprecated; use /v2/event instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAlerts","name":"List all security and operational events across the organization","deprecated":true,"isWebhook":false,"pointer":"/paths/~1alert/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all security and operational events across the organization","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is deprecated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/event"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"alerts::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"timestamp","in":"query","schemaId":"schema_246","description":"Start time (unix timestamp) to query from"},{"name":"limit","in":"query","schemaId":"schema_246","description":"Limit number of alerts to return"}],"pointer":"/paths/~1alert/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/alert","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"timestamp","in":"query","schemaId":"schema_246"},{"name":"limit","in":"query","schemaId":"schema_246"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/alert","href":"/alert/listalerts","openApiOperationId":"listAlerts","summary":"List all security and operational events across the organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_241"}},"schemaId":"schema_241"}],"pointer":"/paths/~1alert/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_241","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_241"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alert/listalerts"}],"panels":[]}]},"httpPath":"/alert"}],"content":{"contentType":"group","meta":{"name":"Alert"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alert","showPageActions":true},{"nodeType":"markdoc","content":"Security and operational events broadcast when significant node or system activity occurs (connects/disconnects, certificate warnings, order updates). Required permissions vary by endpoint; see each operation description for the specific permission needed."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/alert/{nodeID}","summary":"Retrieve security and operational events for a specific node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alert/listnodealerts","deprecated":false},{"title":"/v2/alert","summary":"Retrieve all recent security and operational alerts across the organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alert/listalertsv2","deprecated":false},{"title":"/v2/alert/{nodeID}","summary":"Retrieve security and operational alerts specific to a single node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alert/listnodealertsv2","deprecated":false},{"title":"/v2/alert/{nodeID}/{alertType}","summary":"Manually resolve and dismiss a specific alert type for a node","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alert/paths/~1v2~1alert~1{nodeid}~1{alerttype}/delete","deprecated":false},{"title":"/v2/event","summary":"List audit events across the organization filtered by time range and type","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alert/listevents","deprecated":false},{"title":"/v2/event/{nodeId}","summary":"Get all events by time range for a Node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alert/listnodeevents","deprecated":false},{"title":"/v2/event/{nodeId}/{eventId}","summary":"Validate if a specific event would trigger configured alarm filters","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alert/paths/~1v2~1event~1{nodeid}~1{eventid}/post","deprecated":false},{"title":"/alert","summary":"List all security and operational events across the organization","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/alert/listalerts","deprecated":true}]}]}]}]}},{"type":"separator","label":"Domain","content":null},{"type":"group","label":"Domain","link":"/domain","routeSlug":"/domain","items":[{"label":"Retrieve domain configuration including security and network settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/getdomain","routeSlug":"/domain/getdomain","metadata":{"seo":{"title":"Retrieve domain configuration including security and network settings","description":"Requires domains::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDomain","name":"Retrieve domain configuration including security and network settings","isWebhook":false,"pointer":"/paths/~1domain~1{domainName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve domain configuration including security and network settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domains::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1domain~1{domainName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/domain/{domainName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/domain/{domainName}","href":"/domain/getdomain","openApiOperationId":"getDomain","summary":"Retrieve domain configuration including security and network settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_250"}},"schemaId":"schema_250"},{"code":"404","description":"Not found"}],"pointer":"/paths/~1domain~1{domainName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_250","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_250"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/getdomain"}],"panels":[]}]},"httpPath":"/domain/{domainName}"},{"label":"Configure domain-wide alert thresholds and notification settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1domain~1{domainname}~1config~1alert/put","routeSlug":"/domain/paths/~1domain~1{domainname}~1config~1alert/put","metadata":{"seo":{"title":"Configure domain-wide alert thresholds and notification settings","description":"Requires domains::configure:thresholds permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure domain-wide alert thresholds and notification settings","isWebhook":false,"pointer":"/paths/~1domain~1{domainName}~1config~1alert/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure domain-wide alert thresholds and notification settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domains::configure:thresholds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1domain~1{domainName}~1config~1alert/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_251"}},"schemaId":"schema_251","pointer":"/paths/~1domain~1{domainName}~1config~1alert/put/requestBody","description":"Alert configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/domain/{domainName}/config/alert","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_251"}},"responseCodes":["200","422"],"pointer":"/domain/{domainName}/config/alert","href":"/domain/paths/~1domain~1{domainname}~1config~1alert/put","summary":"Configure domain-wide alert thresholds and notification settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_251","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_251"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1domain~1{domainName}~1config~1alert/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1domain~1{domainname}~1config~1alert/put"}],"panels":[]}]},"httpPath":"/domain/{domainName}/config/alert"},{"label":"Configure domain-level API gateway settings and access policies","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1domain~1{domainname}~1config~1apigw/put","routeSlug":"/domain/paths/~1domain~1{domainname}~1config~1apigw/put","metadata":{"seo":{"title":"Configure domain-level API gateway settings and access policies","description":"Requires domains::configure:gateway permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure domain-level API gateway settings and access policies","isWebhook":false,"pointer":"/paths/~1domain~1{domainName}~1config~1apigw/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure domain-level API gateway settings and access policies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domains::configure:gateway"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1domain~1{domainName}~1config~1apigw/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_252"}},"schemaId":"schema_252","pointer":"/paths/~1domain~1{domainName}~1config~1apigw/put/requestBody","description":"APIGW configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/domain/{domainName}/config/apigw","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_252"}},"responseCodes":["200","422"],"pointer":"/domain/{domainName}/config/apigw","href":"/domain/paths/~1domain~1{domainname}~1config~1apigw/put","summary":"Configure domain-level API gateway settings and access policies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_252","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_252"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1domain~1{domainName}~1config~1apigw/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1domain~1{domainname}~1config~1apigw/put"}],"panels":[]}]},"httpPath":"/domain/{domainName}/config/apigw"},{"label":"List virtual networks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listvirtualnetworks","routeSlug":"/domain/listvirtualnetworks","metadata":{"seo":{"title":"List virtual networks","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listVirtualNetworks","name":"List virtual networks","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List virtual networks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network","href":"/domain/listvirtualnetworks","openApiOperationId":"listVirtualNetworks","summary":"List virtual networks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_253"}},"schemaId":"schema_253"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_253","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_253"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listvirtualnetworks"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network"},{"label":"Create a virtual network network","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network/post","metadata":{"seo":{"title":"Create a virtual network network","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a virtual network network","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a virtual network network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetwork"}},"schemaId":"components/schemas/VirtualNetwork","pointer":"/paths/~1v2~1domain~1{domainName}~1network/post/requestBody","description":"Virtual network configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetwork"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network","href":"/domain/paths/~1v2~1domain~1{domainname}~1network/post","summary":"Create a virtual network network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetwork","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetwork"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network"},{"label":"Delete a virtual network - this change is not staged and will immediately affect the domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete","metadata":{"seo":{"title":"Delete a virtual network - this change is not staged and will immediately affect the domain","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a virtual network - this change is not staged and will immediately affect the domain","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a virtual network - this change is not staged and will immediately affect the domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete","summary":"Delete a virtual network - this change is not staged and will immediately affect the domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}"},{"label":"List a virtual network's access policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listnetworkaccesspolicies","routeSlug":"/domain/listnetworkaccesspolicies","metadata":{"seo":{"title":"List a virtual network's access policies","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkAccessPolicies","name":"List a virtual network's access policies","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a virtual network's access policies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/access-policy","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy","href":"/domain/listnetworkaccesspolicies","openApiOperationId":"listNetworkAccessPolicies","summary":"List a virtual network's access policies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}},"schemaId":"schema_254"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_254","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listnetworkaccesspolicies"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy"},{"label":"Create a network access policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","metadata":{"seo":{"title":"Create a network access policy","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network access policy","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"schemaId":"components/schemas/VirtualNetworkAccessPolicy","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post/requestBody","description":"Access policy configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/access-policy","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","summary":"Create a network access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAccessPolicy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy"},{"label":"Delete a network access policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","metadata":{"seo":{"title":"Delete a network access policy","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network access policy","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accessPolicyID","in":"path","schemaId":"schema_240","description":"Unique ID of access policy","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"accessPolicyID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","summary":"Delete a network access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}"},{"label":"Update a network access policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","metadata":{"seo":{"title":"Update a network access policy","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network access policy","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accessPolicyID","in":"path","schemaId":"schema_240","description":"Unique ID of access policy","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"schemaId":"components/schemas/VirtualNetworkAccessPolicy","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put/requestBody","description":"Access policy configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"accessPolicyID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","summary":"Update a network access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAccessPolicy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}"},{"label":"List a network's auth groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listnetworkauthgroups","routeSlug":"/domain/listnetworkauthgroups","metadata":{"seo":{"title":"List a network's auth groups","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkAuthGroups","name":"List a network's auth groups","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's auth groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/auth-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group","href":"/domain/listnetworkauthgroups","openApiOperationId":"listNetworkAuthGroups","summary":"List a network's auth groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}},"schemaId":"schema_255"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_255","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listnetworkauthgroups"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group"},{"label":"Create a network auth group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","metadata":{"seo":{"title":"Create a network auth group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network auth group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network auth group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post/requestBody","description":"Network auth group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/auth-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","summary":"Create a network auth group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group"},{"label":"Delete a network auth group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","metadata":{"seo":{"title":"Delete a network auth group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network auth group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network auth group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","summary":"Delete a network auth group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"List a network auth group's members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/getnetworkauthgroup","routeSlug":"/domain/getnetworkauthgroup","metadata":{"seo":{"title":"List a network auth group's members","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNetworkAuthGroup","name":"List a network auth group's members","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network auth group's members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/domain/getnetworkauthgroup","openApiOperationId":"getNetworkAuthGroup","summary":"List a network auth group's members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256"}},"schemaId":"schema_256"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_256","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/getnetworkauthgroup"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"Add a network auth group member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","metadata":{"seo":{"title":"Add a network auth group member","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a network auth group member","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a network auth group member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post/requestBody","description":"Network auth group member"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","summary":"Add a network auth group member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"Update a network auth group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","metadata":{"seo":{"title":"Update a network auth group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network auth group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network auth group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put/requestBody","description":"Network auth group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","summary":"Update a network auth group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"Remove a network auth group member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","metadata":{"seo":{"title":"Remove a network auth group member","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a network auth group member","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a network auth group member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberID","in":"path","schemaId":"schema_240","description":"Group member ID","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"memberID","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","summary":"Remove a network auth group member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}"},{"label":"Update a membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","metadata":{"seo":{"title":"Update a membership","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a membership","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberID","in":"path","schemaId":"schema_240","description":"Group member ID","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put/requestBody","description":"Network auth group member"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"memberID","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","summary":"Update a membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}"},{"label":"List staged changes awaiting commit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listnetworkchanges","routeSlug":"/domain/listnetworkchanges","metadata":{"seo":{"title":"List staged changes awaiting commit","description":"Returns staged (uncommitted) changes to the virtual network. Changes are staged before being committed via the change/commit endpoint. Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkChanges","name":"List staged changes awaiting commit","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List staged changes awaiting commit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns staged (uncommitted) changes to the virtual network. Changes are staged before being committed via the change/commit endpoint. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/change","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change","href":"/domain/listnetworkchanges","openApiOperationId":"listNetworkChanges","summary":"List staged changes awaiting commit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_257"}},"schemaId":"schema_257"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_257","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_257"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listnetworkchanges"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change"},{"label":"Commit staged changes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","metadata":{"seo":{"title":"Commit staged changes","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Commit staged changes","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Commit staged changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post/requestBody","description":"Digest"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/change/commit","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_258"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change/commit","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","summary":"Commit staged changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_258","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_258"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change/commit"},{"label":"List validation errors for staged changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/validatenetworkchanges","routeSlug":"/domain/validatenetworkchanges","metadata":{"seo":{"title":"List validation errors for staged changes","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateNetworkChanges","name":"List validation errors for staged changes","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1validate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List validation errors for staged changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1validate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/change/validate","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change/validate","href":"/domain/validatenetworkchanges","openApiOperationId":"validateNetworkChanges","summary":"List validation errors for staged changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1validate/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_258","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}}},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/validatenetworkchanges"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change/validate"},{"label":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","metadata":{"seo":{"title":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1{changeID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"changeID","in":"path","schemaId":"schema_240","description":"Change ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1{changeID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"changeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","summary":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1{changeID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}"},{"label":"Get a network's DNS configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/getnetworkdns","routeSlug":"/domain/getnetworkdns","metadata":{"seo":{"title":"Get a network's DNS configuration","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNetworkDns","name":"Get a network's DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a network's DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns","href":"/domain/getnetworkdns","openApiOperationId":"getNetworkDns","summary":"Get a network's DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualNetworkDNSConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/getnetworkdns"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns"},{"label":"Update a network's DNS configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","metadata":{"seo":{"title":"Update a network's DNS configuration","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network's DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network's DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"schemaId":"components/schemas/VirtualNetworkDNSConfiguration","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put/requestBody","description":"DNS configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","summary":"Update a network's DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns"},{"label":"List a network's DNS zones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listnetworkdnszones","routeSlug":"/domain/listnetworkdnszones","metadata":{"seo":{"title":"List a network's DNS zones","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkDnsZones","name":"List a network's DNS zones","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's DNS zones","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone","href":"/domain/listnetworkdnszones","openApiOperationId":"listNetworkDnsZones","summary":"List a network's DNS zones"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}},"schemaId":"schema_259"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_259","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listnetworkdnszones"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone"},{"label":"Create a DNS zone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","metadata":{"seo":{"title":"Create a DNS zone","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a DNS zone","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a DNS zone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"schemaId":"components/schemas/VirtualNetworkDNSZone","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post/requestBody","description":"DNS zone configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","summary":"Create a DNS zone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSZone","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone"},{"label":"Delete a DNS zone","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","metadata":{"seo":{"title":"Delete a DNS zone","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a DNS zone","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a DNS zone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","summary":"Delete a DNS zone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}"},{"label":"Update a DNS zone","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","metadata":{"seo":{"title":"Update a DNS zone","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a DNS zone","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a DNS zone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"schemaId":"components/schemas/VirtualNetworkDNSZone","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put/requestBody","description":"DNS zone configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","summary":"Update a DNS zone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSZone","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}"},{"label":"List a network zone's DNS records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listnetworkdnsrecords","routeSlug":"/domain/listnetworkdnsrecords","metadata":{"seo":{"title":"List a network zone's DNS records","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkDnsRecords","name":"List a network zone's DNS records","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network zone's DNS records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","href":"/domain/listnetworkdnsrecords","openApiOperationId":"listNetworkDnsRecords","summary":"List a network zone's DNS records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260"}},"schemaId":"schema_260"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_260","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listnetworkdnsrecords"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record"},{"label":"Create a DNS record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","metadata":{"seo":{"title":"Create a DNS record","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a DNS record","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a DNS record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"schemaId":"components/schemas/VirtualNetworkDNSRecord","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post/requestBody","description":"DNS record configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","summary":"Create a DNS record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSRecord","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record"},{"label":"Delete a DNS record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","metadata":{"seo":{"title":"Delete a DNS record","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a DNS record","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a DNS record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"recordType","in":"path","schemaId":"schema_240","description":"DNS record type","required":true},{"name":"recordName","in":"path","schemaId":"schema_240","description":"DNS record name","required":true},{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"recordType","in":"path","required":true,"schemaId":"schema_240"},{"name":"recordName","in":"path","required":true,"schemaId":"schema_240"},{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","summary":"Delete a DNS record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}"},{"label":"Update a DNS record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","metadata":{"seo":{"title":"Update a DNS record","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a DNS record","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a DNS record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"recordType","in":"path","schemaId":"schema_240","description":"DNS record type","required":true},{"name":"recordName","in":"path","schemaId":"schema_240","description":"DNS record name","required":true},{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"schemaId":"components/schemas/VirtualNetworkDNSRecord","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put/requestBody","description":"DNS record configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"recordType","in":"path","required":true,"schemaId":"schema_240"},{"name":"recordName","in":"path","required":true,"schemaId":"schema_240"},{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","summary":"Update a DNS record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSRecord","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}"},{"label":"List a network's groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listnetworkgroups","routeSlug":"/domain/listnetworkgroups","metadata":{"seo":{"title":"List a network's groups","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkGroups","name":"List a network's groups","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/network-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group","href":"/domain/listnetworkgroups","openApiOperationId":"listNetworkGroups","summary":"List a network's groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261"}},"schemaId":"schema_261"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_261","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listnetworkgroups"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group"},{"label":"Create a network group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","metadata":{"seo":{"title":"Create a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"schemaId":"components/schemas/VirtualNetworkGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post/requestBody","description":"Network group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/network-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","summary":"Create a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group"},{"label":"Delete a network group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","metadata":{"seo":{"title":"Delete a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","summary":"Delete a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}"},{"label":"List a network's group memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/getnetworkgroup","routeSlug":"/domain/getnetworkgroup","metadata":{"seo":{"title":"List a network's group memberships","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNetworkGroup","name":"List a network's group memberships","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's group memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","href":"/domain/getnetworkgroup","openApiOperationId":"getNetworkGroup","summary":"List a network's group memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}},"schemaId":"schema_262"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_262","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/getnetworkgroup"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}"},{"label":"Update a network group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","metadata":{"seo":{"title":"Update a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"schemaId":"components/schemas/VirtualNetworkGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put/requestBody","description":"Network group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","summary":"Update a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}"},{"label":"Remove a network object from a network group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","metadata":{"seo":{"title":"Remove a network object from a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a network object from a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a network object from a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","summary":"Remove a network object from a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}"},{"label":"Add a network object to a network group (represented by a network group membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","metadata":{"seo":{"title":"Add a network object to a network group (represented by a network group membership","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a network object to a network group (represented by a network group membership","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a network object to a network group (represented by a network group membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","summary":"Add a network object to a network group (represented by a network group membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}"},{"label":"List a network's objects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listnetworkobjects","routeSlug":"/domain/listnetworkobjects","metadata":{"seo":{"title":"List a network's objects","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkObjects","name":"List a network's objects","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's objects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/network-object","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object","href":"/domain/listnetworkobjects","openApiOperationId":"listNetworkObjects","summary":"List a network's objects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}},"schemaId":"schema_263"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_263","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listnetworkobjects"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object"},{"label":"Create a network object","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","metadata":{"seo":{"title":"Create a network object","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network object","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"schemaId":"components/schemas/VirtualNetworkObject","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post/requestBody","description":"Network object configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/network-object","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","summary":"Create a network object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object"},{"label":"Delete a network object","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","metadata":{"seo":{"title":"Delete a network object","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network object","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","summary":"Delete a network object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}"},{"label":"Update a network object","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","metadata":{"seo":{"title":"Update a network object","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network object","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"schemaId":"components/schemas/VirtualNetworkObject","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put/requestBody","description":"Network object configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","summary":"Update a network object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}"},{"label":"List a network's port forwardings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listnetworkportforwardings","routeSlug":"/domain/listnetworkportforwardings","metadata":{"seo":{"title":"List a network's port forwardings","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkPortForwardings","name":"List a network's port forwardings","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's port forwardings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","href":"/domain/listnetworkportforwardings","openApiOperationId":"listNetworkPortForwardings","summary":"List a network's port forwardings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}},"schemaId":"schema_264"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_264","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listnetworkportforwardings"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding"},{"label":"Create a port forwarding","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","metadata":{"seo":{"title":"Create a port forwarding","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a port forwarding","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a port forwarding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"schemaId":"components/schemas/PortForwarding","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post/requestBody","description":"Port forwarding configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","summary":"Create a port forwarding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/PortForwarding","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding"},{"label":"Get a port forwarding","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","metadata":{"seo":{"title":"Get a port forwarding","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get a port forwarding","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a port forwarding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portForwardingID","in":"path","schemaId":"schema_240","description":"Port forwarding ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"portForwardingID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","summary":"Get a port forwarding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"schemaId":"components/schemas/PortForwarding"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortForwarding","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortForwarding"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}"},{"label":"Update a port forwarding","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","metadata":{"seo":{"title":"Update a port forwarding","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a port forwarding","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a port forwarding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portForwardingID","in":"path","schemaId":"schema_240","description":"Port forwarding ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"schemaId":"components/schemas/PortForwarding","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put/requestBody","description":"Port forwarding configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"portForwardingID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","summary":"Update a port forwarding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/PortForwarding","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}"},{"label":"Get default global vpn routes for a virtual network","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/listnetworkroutes","routeSlug":"/domain/listnetworkroutes","metadata":{"seo":{"title":"Get default global vpn routes for a virtual network","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkRoutes","name":"Get default global vpn routes for a virtual network","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get default global vpn routes for a virtual network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route","href":"/domain/listnetworkroutes","openApiOperationId":"listNetworkRoutes","summary":"Get default global vpn routes for a virtual network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}},"schemaId":"schema_265"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_265","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/listnetworkroutes"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route"},{"label":"Create a network route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","metadata":{"seo":{"title":"Create a network route","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network route","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"schemaId":"components/schemas/VirtualNetworkRoute","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post/requestBody","description":"Route configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","summary":"Create a network route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkRoute","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route"},{"label":"Delete a network route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","metadata":{"seo":{"title":"Delete a network route","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network route","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"routeID","in":"path","schemaId":"schema_240","description":"Route ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"routeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","summary":"Delete a network route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}"},{"label":"Update a network route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","routeSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","metadata":{"seo":{"title":"Update a network route","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network route","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"routeID","in":"path","schemaId":"schema_240","description":"Route ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"schemaId":"components/schemas/VirtualNetworkRoute","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put/requestBody","description":"Route configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"routeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","href":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","summary":"Update a network route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkRoute","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}"}],"content":{"contentType":"group","meta":{"name":"Domain"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Domain","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/domain/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"domain"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a logical grouping of nodes within an organization, providing the namespace for virtual networks, DNS zones, and access policies. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"domains::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/domain/{domainName}","summary":"Retrieve domain configuration including security and network settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/getdomain","deprecated":false},{"title":"/domain/{domainName}/config/alert","summary":"Configure domain-wide alert thresholds and notification settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1domain~1{domainname}~1config~1alert/put","deprecated":false},{"title":"/domain/{domainName}/config/apigw","summary":"Configure domain-level API gateway settings and access policies","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1domain~1{domainname}~1config~1apigw/put","deprecated":false},{"title":"/v2/domain/{domainName}/network","summary":"List virtual networks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listvirtualnetworks","deprecated":false},{"title":"/v2/domain/{domainName}/network","summary":"Create a virtual network network","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}","summary":"Delete a virtual network - this change is not staged and will immediately affect the domain","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy","summary":"List a virtual network's access policies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listnetworkaccesspolicies","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy","summary":"Create a network access policy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","summary":"Delete a network access policy","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","summary":"Update a network access policy","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group","summary":"List a network's auth groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listnetworkauthgroups","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group","summary":"Create a network auth group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"Delete a network auth group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"List a network auth group's members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/getnetworkauthgroup","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"Add a network auth group member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"Update a network auth group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","summary":"Remove a network auth group member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","summary":"Update a membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change","summary":"List staged changes awaiting commit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listnetworkchanges","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change/commit","summary":"Commit staged changes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change/validate","summary":"List validation errors for staged changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/validatenetworkchanges","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}","summary":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns","summary":"Get a network's DNS configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/getnetworkdns","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns","summary":"Update a network's DNS configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone","summary":"List a network's DNS zones","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listnetworkdnszones","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone","summary":"Create a DNS zone","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","summary":"Delete a DNS zone","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","summary":"Update a DNS zone","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","summary":"List a network zone's DNS records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listnetworkdnsrecords","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","summary":"Create a DNS record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","summary":"Delete a DNS record","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","summary":"Update a DNS record","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group","summary":"List a network's groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listnetworkgroups","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group","summary":"Create a network group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","summary":"Delete a network group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","summary":"List a network's group memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/getnetworkgroup","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","summary":"Update a network group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","summary":"Remove a network object from a network group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","summary":"Add a network object to a network group (represented by a network group membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object","summary":"List a network's objects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listnetworkobjects","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object","summary":"Create a network object","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","summary":"Delete a network object","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","summary":"Update a network object","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","summary":"List a network's port forwardings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listnetworkportforwardings","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","summary":"Create a port forwarding","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","summary":"Get a port forwarding","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","summary":"Update a port forwarding","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route","summary":"Get default global vpn routes for a virtual network","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain/listnetworkroutes","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route","summary":"Create a network route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","summary":"Delete a network route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","summary":"Update a network route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domain/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Virtual Networks","link":"/virtual-networks","routeSlug":"/virtual-networks","items":[{"label":"List virtual networks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listvirtualnetworks","routeSlug":"/virtual-networks/listvirtualnetworks","metadata":{"seo":{"title":"List virtual networks","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listVirtualNetworks","name":"List virtual networks","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List virtual networks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network","href":"/virtual-networks/listvirtualnetworks","openApiOperationId":"listVirtualNetworks","summary":"List virtual networks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_253"}},"schemaId":"schema_253"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_253","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_253"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listvirtualnetworks"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network"},{"label":"Create a virtual network network","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network/post","metadata":{"seo":{"title":"Create a virtual network network","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a virtual network network","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a virtual network network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetwork"}},"schemaId":"components/schemas/VirtualNetwork","pointer":"/paths/~1v2~1domain~1{domainName}~1network/post/requestBody","description":"Virtual network configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetwork"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network/post","summary":"Create a virtual network network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetwork","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetwork"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network"},{"label":"Delete a virtual network - this change is not staged and will immediately affect the domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete","metadata":{"seo":{"title":"Delete a virtual network - this change is not staged and will immediately affect the domain","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a virtual network - this change is not staged and will immediately affect the domain","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a virtual network - this change is not staged and will immediately affect the domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete","summary":"Delete a virtual network - this change is not staged and will immediately affect the domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}"},{"label":"List a virtual network's access policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listnetworkaccesspolicies","routeSlug":"/virtual-networks/listnetworkaccesspolicies","metadata":{"seo":{"title":"List a virtual network's access policies","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkAccessPolicies","name":"List a virtual network's access policies","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a virtual network's access policies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/access-policy","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy","href":"/virtual-networks/listnetworkaccesspolicies","openApiOperationId":"listNetworkAccessPolicies","summary":"List a virtual network's access policies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}},"schemaId":"schema_254"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_254","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listnetworkaccesspolicies"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy"},{"label":"Create a network access policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","metadata":{"seo":{"title":"Create a network access policy","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network access policy","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"schemaId":"components/schemas/VirtualNetworkAccessPolicy","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post/requestBody","description":"Access policy configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/access-policy","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","summary":"Create a network access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAccessPolicy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy"},{"label":"Delete a network access policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","metadata":{"seo":{"title":"Delete a network access policy","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network access policy","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accessPolicyID","in":"path","schemaId":"schema_240","description":"Unique ID of access policy","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"accessPolicyID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","summary":"Delete a network access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}"},{"label":"Update a network access policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","metadata":{"seo":{"title":"Update a network access policy","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network access policy","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accessPolicyID","in":"path","schemaId":"schema_240","description":"Unique ID of access policy","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"schemaId":"components/schemas/VirtualNetworkAccessPolicy","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put/requestBody","description":"Access policy configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"accessPolicyID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","summary":"Update a network access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAccessPolicy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}"},{"label":"List a network's auth groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listnetworkauthgroups","routeSlug":"/virtual-networks/listnetworkauthgroups","metadata":{"seo":{"title":"List a network's auth groups","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkAuthGroups","name":"List a network's auth groups","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's auth groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/auth-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group","href":"/virtual-networks/listnetworkauthgroups","openApiOperationId":"listNetworkAuthGroups","summary":"List a network's auth groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}},"schemaId":"schema_255"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_255","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listnetworkauthgroups"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group"},{"label":"Create a network auth group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","metadata":{"seo":{"title":"Create a network auth group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network auth group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network auth group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post/requestBody","description":"Network auth group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/auth-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","summary":"Create a network auth group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group"},{"label":"Delete a network auth group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","metadata":{"seo":{"title":"Delete a network auth group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network auth group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network auth group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","summary":"Delete a network auth group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"List a network auth group's members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/getnetworkauthgroup","routeSlug":"/virtual-networks/getnetworkauthgroup","metadata":{"seo":{"title":"List a network auth group's members","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNetworkAuthGroup","name":"List a network auth group's members","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network auth group's members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/virtual-networks/getnetworkauthgroup","openApiOperationId":"getNetworkAuthGroup","summary":"List a network auth group's members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256"}},"schemaId":"schema_256"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_256","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/getnetworkauthgroup"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"Add a network auth group member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","metadata":{"seo":{"title":"Add a network auth group member","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a network auth group member","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a network auth group member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post/requestBody","description":"Network auth group member"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","summary":"Add a network auth group member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"Update a network auth group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","metadata":{"seo":{"title":"Update a network auth group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network auth group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network auth group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put/requestBody","description":"Network auth group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","summary":"Update a network auth group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"Remove a network auth group member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","metadata":{"seo":{"title":"Remove a network auth group member","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a network auth group member","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a network auth group member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberID","in":"path","schemaId":"schema_240","description":"Group member ID","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"memberID","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","summary":"Remove a network auth group member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}"},{"label":"Update a membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","metadata":{"seo":{"title":"Update a membership","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a membership","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberID","in":"path","schemaId":"schema_240","description":"Group member ID","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put/requestBody","description":"Network auth group member"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"memberID","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","summary":"Update a membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}"},{"label":"List staged changes awaiting commit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listnetworkchanges","routeSlug":"/virtual-networks/listnetworkchanges","metadata":{"seo":{"title":"List staged changes awaiting commit","description":"Returns staged (uncommitted) changes to the virtual network. Changes are staged before being committed via the change/commit endpoint. Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkChanges","name":"List staged changes awaiting commit","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List staged changes awaiting commit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns staged (uncommitted) changes to the virtual network. Changes are staged before being committed via the change/commit endpoint. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/change","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change","href":"/virtual-networks/listnetworkchanges","openApiOperationId":"listNetworkChanges","summary":"List staged changes awaiting commit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_257"}},"schemaId":"schema_257"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_257","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_257"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listnetworkchanges"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change"},{"label":"Commit staged changes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","metadata":{"seo":{"title":"Commit staged changes","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Commit staged changes","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Commit staged changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post/requestBody","description":"Digest"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/change/commit","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_258"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change/commit","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","summary":"Commit staged changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_258","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_258"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change/commit"},{"label":"List validation errors for staged changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/validatenetworkchanges","routeSlug":"/virtual-networks/validatenetworkchanges","metadata":{"seo":{"title":"List validation errors for staged changes","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateNetworkChanges","name":"List validation errors for staged changes","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1validate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List validation errors for staged changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1validate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/change/validate","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change/validate","href":"/virtual-networks/validatenetworkchanges","openApiOperationId":"validateNetworkChanges","summary":"List validation errors for staged changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1validate/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_258","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}}},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/validatenetworkchanges"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change/validate"},{"label":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","metadata":{"seo":{"title":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1{changeID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"changeID","in":"path","schemaId":"schema_240","description":"Change ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1{changeID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"changeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","summary":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1{changeID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}"},{"label":"Get a network's DNS configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/getnetworkdns","routeSlug":"/virtual-networks/getnetworkdns","metadata":{"seo":{"title":"Get a network's DNS configuration","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNetworkDns","name":"Get a network's DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a network's DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns","href":"/virtual-networks/getnetworkdns","openApiOperationId":"getNetworkDns","summary":"Get a network's DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualNetworkDNSConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/getnetworkdns"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns"},{"label":"Update a network's DNS configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","metadata":{"seo":{"title":"Update a network's DNS configuration","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network's DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network's DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"schemaId":"components/schemas/VirtualNetworkDNSConfiguration","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put/requestBody","description":"DNS configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","summary":"Update a network's DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns"},{"label":"List a network's DNS zones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listnetworkdnszones","routeSlug":"/virtual-networks/listnetworkdnszones","metadata":{"seo":{"title":"List a network's DNS zones","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkDnsZones","name":"List a network's DNS zones","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's DNS zones","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone","href":"/virtual-networks/listnetworkdnszones","openApiOperationId":"listNetworkDnsZones","summary":"List a network's DNS zones"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}},"schemaId":"schema_259"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_259","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listnetworkdnszones"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone"},{"label":"Create a DNS zone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","metadata":{"seo":{"title":"Create a DNS zone","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a DNS zone","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a DNS zone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"schemaId":"components/schemas/VirtualNetworkDNSZone","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post/requestBody","description":"DNS zone configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","summary":"Create a DNS zone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSZone","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone"},{"label":"Delete a DNS zone","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","metadata":{"seo":{"title":"Delete a DNS zone","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a DNS zone","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a DNS zone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","summary":"Delete a DNS zone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}"},{"label":"Update a DNS zone","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","metadata":{"seo":{"title":"Update a DNS zone","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a DNS zone","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a DNS zone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"schemaId":"components/schemas/VirtualNetworkDNSZone","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put/requestBody","description":"DNS zone configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","summary":"Update a DNS zone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSZone","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}"},{"label":"List a network zone's DNS records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listnetworkdnsrecords","routeSlug":"/virtual-networks/listnetworkdnsrecords","metadata":{"seo":{"title":"List a network zone's DNS records","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkDnsRecords","name":"List a network zone's DNS records","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network zone's DNS records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","href":"/virtual-networks/listnetworkdnsrecords","openApiOperationId":"listNetworkDnsRecords","summary":"List a network zone's DNS records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260"}},"schemaId":"schema_260"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_260","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listnetworkdnsrecords"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record"},{"label":"Create a DNS record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","metadata":{"seo":{"title":"Create a DNS record","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a DNS record","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a DNS record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"schemaId":"components/schemas/VirtualNetworkDNSRecord","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post/requestBody","description":"DNS record configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","summary":"Create a DNS record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSRecord","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record"},{"label":"Delete a DNS record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","metadata":{"seo":{"title":"Delete a DNS record","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a DNS record","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a DNS record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"recordType","in":"path","schemaId":"schema_240","description":"DNS record type","required":true},{"name":"recordName","in":"path","schemaId":"schema_240","description":"DNS record name","required":true},{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"recordType","in":"path","required":true,"schemaId":"schema_240"},{"name":"recordName","in":"path","required":true,"schemaId":"schema_240"},{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","summary":"Delete a DNS record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}"},{"label":"Update a DNS record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","metadata":{"seo":{"title":"Update a DNS record","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a DNS record","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a DNS record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"recordType","in":"path","schemaId":"schema_240","description":"DNS record type","required":true},{"name":"recordName","in":"path","schemaId":"schema_240","description":"DNS record name","required":true},{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"schemaId":"components/schemas/VirtualNetworkDNSRecord","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put/requestBody","description":"DNS record configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"recordType","in":"path","required":true,"schemaId":"schema_240"},{"name":"recordName","in":"path","required":true,"schemaId":"schema_240"},{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","summary":"Update a DNS record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSRecord","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}"},{"label":"List a network's groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listnetworkgroups","routeSlug":"/virtual-networks/listnetworkgroups","metadata":{"seo":{"title":"List a network's groups","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkGroups","name":"List a network's groups","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/network-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group","href":"/virtual-networks/listnetworkgroups","openApiOperationId":"listNetworkGroups","summary":"List a network's groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261"}},"schemaId":"schema_261"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_261","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listnetworkgroups"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group"},{"label":"Create a network group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","metadata":{"seo":{"title":"Create a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"schemaId":"components/schemas/VirtualNetworkGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post/requestBody","description":"Network group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/network-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","summary":"Create a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group"},{"label":"Delete a network group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","metadata":{"seo":{"title":"Delete a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","summary":"Delete a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}"},{"label":"List a network's group memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/getnetworkgroup","routeSlug":"/virtual-networks/getnetworkgroup","metadata":{"seo":{"title":"List a network's group memberships","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNetworkGroup","name":"List a network's group memberships","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's group memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","href":"/virtual-networks/getnetworkgroup","openApiOperationId":"getNetworkGroup","summary":"List a network's group memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}},"schemaId":"schema_262"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_262","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/getnetworkgroup"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}"},{"label":"Update a network group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","metadata":{"seo":{"title":"Update a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"schemaId":"components/schemas/VirtualNetworkGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put/requestBody","description":"Network group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","summary":"Update a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}"},{"label":"Remove a network object from a network group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","metadata":{"seo":{"title":"Remove a network object from a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a network object from a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a network object from a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","summary":"Remove a network object from a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}"},{"label":"Add a network object to a network group (represented by a network group membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","metadata":{"seo":{"title":"Add a network object to a network group (represented by a network group membership","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a network object to a network group (represented by a network group membership","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a network object to a network group (represented by a network group membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","summary":"Add a network object to a network group (represented by a network group membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}"},{"label":"List a network's objects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listnetworkobjects","routeSlug":"/virtual-networks/listnetworkobjects","metadata":{"seo":{"title":"List a network's objects","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkObjects","name":"List a network's objects","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's objects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/network-object","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object","href":"/virtual-networks/listnetworkobjects","openApiOperationId":"listNetworkObjects","summary":"List a network's objects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}},"schemaId":"schema_263"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_263","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listnetworkobjects"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object"},{"label":"Create a network object","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","metadata":{"seo":{"title":"Create a network object","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network object","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"schemaId":"components/schemas/VirtualNetworkObject","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post/requestBody","description":"Network object configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/network-object","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","summary":"Create a network object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object"},{"label":"Delete a network object","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","metadata":{"seo":{"title":"Delete a network object","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network object","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","summary":"Delete a network object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}"},{"label":"Update a network object","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","metadata":{"seo":{"title":"Update a network object","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network object","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"schemaId":"components/schemas/VirtualNetworkObject","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put/requestBody","description":"Network object configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","summary":"Update a network object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}"},{"label":"List a network's port forwardings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listnetworkportforwardings","routeSlug":"/virtual-networks/listnetworkportforwardings","metadata":{"seo":{"title":"List a network's port forwardings","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkPortForwardings","name":"List a network's port forwardings","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's port forwardings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","href":"/virtual-networks/listnetworkportforwardings","openApiOperationId":"listNetworkPortForwardings","summary":"List a network's port forwardings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}},"schemaId":"schema_264"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_264","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listnetworkportforwardings"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding"},{"label":"Create a port forwarding","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","metadata":{"seo":{"title":"Create a port forwarding","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a port forwarding","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a port forwarding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"schemaId":"components/schemas/PortForwarding","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post/requestBody","description":"Port forwarding configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","summary":"Create a port forwarding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/PortForwarding","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding"},{"label":"Get a port forwarding","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","metadata":{"seo":{"title":"Get a port forwarding","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get a port forwarding","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a port forwarding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portForwardingID","in":"path","schemaId":"schema_240","description":"Port forwarding ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"portForwardingID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","summary":"Get a port forwarding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"schemaId":"components/schemas/PortForwarding"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortForwarding","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortForwarding"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}"},{"label":"Update a port forwarding","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","metadata":{"seo":{"title":"Update a port forwarding","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a port forwarding","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a port forwarding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portForwardingID","in":"path","schemaId":"schema_240","description":"Port forwarding ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"schemaId":"components/schemas/PortForwarding","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put/requestBody","description":"Port forwarding configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"portForwardingID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","summary":"Update a port forwarding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/PortForwarding","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}"},{"label":"Get default global vpn routes for a virtual network","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/listnetworkroutes","routeSlug":"/virtual-networks/listnetworkroutes","metadata":{"seo":{"title":"Get default global vpn routes for a virtual network","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkRoutes","name":"Get default global vpn routes for a virtual network","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get default global vpn routes for a virtual network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route","href":"/virtual-networks/listnetworkroutes","openApiOperationId":"listNetworkRoutes","summary":"Get default global vpn routes for a virtual network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}},"schemaId":"schema_265"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_265","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/listnetworkroutes"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route"},{"label":"Create a network route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","metadata":{"seo":{"title":"Create a network route","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network route","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"schemaId":"components/schemas/VirtualNetworkRoute","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post/requestBody","description":"Route configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","summary":"Create a network route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkRoute","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route"},{"label":"Delete a network route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","metadata":{"seo":{"title":"Delete a network route","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network route","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"routeID","in":"path","schemaId":"schema_240","description":"Route ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"routeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","summary":"Delete a network route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}"},{"label":"Update a network route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","routeSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","metadata":{"seo":{"title":"Update a network route","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network route","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"routeID","in":"path","schemaId":"schema_240","description":"Route ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"schemaId":"components/schemas/VirtualNetworkRoute","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put/requestBody","description":"Route configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"routeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","href":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","summary":"Update a network route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkRoute","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}"}],"content":{"contentType":"group","meta":{"name":"Virtual Networks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual Networks","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/domain/virtual-networks/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual networks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are Layer-3 overlay networks enabling zero-trust connectivity between nodes. Configure routes, DNS, access policies, port forwarding, and IP pools. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network","summary":"List virtual networks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listvirtualnetworks","deprecated":false},{"title":"/v2/domain/{domainName}/network","summary":"Create a virtual network network","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}","summary":"Delete a virtual network - this change is not staged and will immediately affect the domain","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy","summary":"List a virtual network's access policies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listnetworkaccesspolicies","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy","summary":"Create a network access policy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","summary":"Delete a network access policy","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","summary":"Update a network access policy","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group","summary":"List a network's auth groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listnetworkauthgroups","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group","summary":"Create a network auth group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"Delete a network auth group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"List a network auth group's members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/getnetworkauthgroup","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"Add a network auth group member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"Update a network auth group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","summary":"Remove a network auth group member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","summary":"Update a membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change","summary":"List staged changes awaiting commit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listnetworkchanges","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change/commit","summary":"Commit staged changes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change/validate","summary":"List validation errors for staged changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/validatenetworkchanges","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}","summary":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns","summary":"Get a network's DNS configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/getnetworkdns","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns","summary":"Update a network's DNS configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone","summary":"List a network's DNS zones","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listnetworkdnszones","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone","summary":"Create a DNS zone","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","summary":"Delete a DNS zone","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","summary":"Update a DNS zone","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","summary":"List a network zone's DNS records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listnetworkdnsrecords","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","summary":"Create a DNS record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","summary":"Delete a DNS record","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","summary":"Update a DNS record","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group","summary":"List a network's groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listnetworkgroups","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group","summary":"Create a network group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","summary":"Delete a network group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","summary":"List a network's group memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/getnetworkgroup","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","summary":"Update a network group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","summary":"Remove a network object from a network group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","summary":"Add a network object to a network group (represented by a network group membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object","summary":"List a network's objects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listnetworkobjects","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object","summary":"Create a network object","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","summary":"Delete a network object","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","summary":"Update a network object","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","summary":"List a network's port forwardings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listnetworkportforwardings","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","summary":"Create a port forwarding","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","summary":"Get a port forwarding","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","summary":"Update a port forwarding","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route","summary":"Get default global vpn routes for a virtual network","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtual-networks/listnetworkroutes","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route","summary":"Create a network route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","summary":"Delete a network route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","summary":"Update a network route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtual-networks/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Access Policy","link":"/access-policy","routeSlug":"/access-policy","items":[{"label":"List a virtual network's access policies","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/access-policy/listnetworkaccesspolicies","routeSlug":"/access-policy/listnetworkaccesspolicies","metadata":{"seo":{"title":"List a virtual network's access policies","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkAccessPolicies","name":"List a virtual network's access policies","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a virtual network's access policies","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/access-policy","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy","href":"/access-policy/listnetworkaccesspolicies","openApiOperationId":"listNetworkAccessPolicies","summary":"List a virtual network's access policies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}},"schemaId":"schema_254"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_254","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_254"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-policy/listnetworkaccesspolicies"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy"},{"label":"Create a network access policy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","routeSlug":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","metadata":{"seo":{"title":"Create a network access policy","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network access policy","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"schemaId":"components/schemas/VirtualNetworkAccessPolicy","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post/requestBody","description":"Access policy configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/access-policy","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy","href":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","summary":"Create a network access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAccessPolicy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy"},{"label":"Delete a network access policy","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","routeSlug":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","metadata":{"seo":{"title":"Delete a network access policy","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network access policy","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accessPolicyID","in":"path","schemaId":"schema_240","description":"Unique ID of access policy","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"accessPolicyID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","href":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","summary":"Delete a network access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}"},{"label":"Update a network access policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","routeSlug":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","metadata":{"seo":{"title":"Update a network access policy","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network access policy","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"accessPolicyID","in":"path","schemaId":"schema_240","description":"Unique ID of access policy","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"schemaId":"components/schemas/VirtualNetworkAccessPolicy","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put/requestBody","description":"Access policy configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"accessPolicyID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","href":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","summary":"Update a network access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAccessPolicy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAccessPolicy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1access-policy~1{accessPolicyID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}"}],"content":{"contentType":"group","meta":{"name":"Access Policy"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Access Policy","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access policies within virtual networks controlling which nodes and groups can communicate. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy","summary":"List a virtual network's access policies","prefix":{"name":"get","color":"get"},"badges":[],"link":"/access-policy/listnetworkaccesspolicies","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy","summary":"Create a network access policy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","summary":"Delete a network access policy","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/access-policy/{accessPolicyID}","summary":"Update a network access policy","prefix":{"name":"put","color":"put"},"badges":[],"link":"/access-policy/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1access-policy~1{accesspolicyid}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Change Management","link":"/change-management","routeSlug":"/change-management","items":[{"label":"List staged changes awaiting commit","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/change-management/listnetworkchanges","routeSlug":"/change-management/listnetworkchanges","metadata":{"seo":{"title":"List staged changes awaiting commit","description":"Returns staged (uncommitted) changes to the virtual network. Changes are staged before being committed via the change/commit endpoint. Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkChanges","name":"List staged changes awaiting commit","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List staged changes awaiting commit","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns staged (uncommitted) changes to the virtual network. Changes are staged before being committed via the change/commit endpoint. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/change","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change","href":"/change-management/listnetworkchanges","openApiOperationId":"listNetworkChanges","summary":"List staged changes awaiting commit"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_257"}},"schemaId":"schema_257"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_257","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_257"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-management/listnetworkchanges"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change"},{"label":"Commit staged changes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","routeSlug":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","metadata":{"seo":{"title":"Commit staged changes","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Commit staged changes","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Commit staged changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post/requestBody","description":"Digest"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/change/commit","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_258"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change/commit","href":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","summary":"Commit staged changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_258","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_258"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1commit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change/commit"},{"label":"List validation errors for staged changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/change-management/validatenetworkchanges","routeSlug":"/change-management/validatenetworkchanges","metadata":{"seo":{"title":"List validation errors for staged changes","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateNetworkChanges","name":"List validation errors for staged changes","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1validate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List validation errors for staged changes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1validate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/change/validate","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change/validate","href":"/change-management/validatenetworkchanges","openApiOperationId":"validateNetworkChanges","summary":"List validation errors for staged changes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}},"schemaId":"schema_258"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1validate/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_258","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_258"}}},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-management/validatenetworkchanges"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change/validate"},{"label":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","routeSlug":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","metadata":{"seo":{"title":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1{changeID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"changeID","in":"path","schemaId":"schema_240","description":"Change ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1{changeID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"changeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}","href":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","summary":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1change~1{changeID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}"}],"content":{"contentType":"group","meta":{"name":"Change Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Change Management","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracked network configuration changes with approval workflows. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view changes, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to stage and commit changes."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/change","summary":"List staged changes awaiting commit","prefix":{"name":"get","color":"get"},"badges":[],"link":"/change-management/listnetworkchanges","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change/commit","summary":"Commit staged changes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1commit/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change/validate","summary":"List validation errors for staged changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/change-management/validatenetworkchanges","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/change/{changeID}","summary":"Revert a staged change. If the item is newly added and not committed, the item will be deleted along with any associated changes.","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/change-management/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1change~1{changeid}/delete","deprecated":false}]}]}]}]}},{"type":"group","label":"DNS","link":"/dns","routeSlug":"/dns","items":[{"label":"Get a network's DNS configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns/getnetworkdns","routeSlug":"/dns/getnetworkdns","metadata":{"seo":{"title":"Get a network's DNS configuration","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNetworkDns","name":"Get a network's DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a network's DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns","href":"/dns/getnetworkdns","openApiOperationId":"getNetworkDns","summary":"Get a network's DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualNetworkDNSConfiguration","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns/getnetworkdns"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns"},{"label":"Update a network's DNS configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","routeSlug":"/dns/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","metadata":{"seo":{"title":"Update a network's DNS configuration","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network's DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network's DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"schemaId":"components/schemas/VirtualNetworkDNSConfiguration","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put/requestBody","description":"DNS configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns","href":"/dns/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","summary":"Update a network's DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSConfiguration","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSConfiguration"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns"}],"content":{"contentType":"group","meta":{"name":"DNS"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DNS","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS configuration within virtual networks, including zone and record management for resolving names across the overlay network. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/dns","summary":"Get a network's DNS configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dns/getnetworkdns","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns","summary":"Update a network's DNS configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/dns/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns/put","deprecated":false}]}]}]}]}},{"type":"group","label":"DNS Zone","link":"/dns-zone","routeSlug":"/dns-zone","items":[{"label":"List a network's DNS zones","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns-zone/listnetworkdnszones","routeSlug":"/dns-zone/listnetworkdnszones","metadata":{"seo":{"title":"List a network's DNS zones","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkDnsZones","name":"List a network's DNS zones","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's DNS zones","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone","href":"/dns-zone/listnetworkdnszones","openApiOperationId":"listNetworkDnsZones","summary":"List a network's DNS zones"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}},"schemaId":"schema_259"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_259","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_259"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns-zone/listnetworkdnszones"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone"},{"label":"Create a DNS zone","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","routeSlug":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","metadata":{"seo":{"title":"Create a DNS zone","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a DNS zone","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a DNS zone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"schemaId":"components/schemas/VirtualNetworkDNSZone","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post/requestBody","description":"DNS zone configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone","href":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","summary":"Create a DNS zone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSZone","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone"},{"label":"Delete a DNS zone","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","routeSlug":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","metadata":{"seo":{"title":"Delete a DNS zone","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a DNS zone","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a DNS zone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","href":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","summary":"Delete a DNS zone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}"},{"label":"Update a DNS zone","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","routeSlug":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","metadata":{"seo":{"title":"Update a DNS zone","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a DNS zone","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a DNS zone","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"schemaId":"components/schemas/VirtualNetworkDNSZone","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put/requestBody","description":"DNS zone configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","href":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","summary":"Update a DNS zone"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSZone","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSZone"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}"}],"content":{"contentType":"group","meta":{"name":"DNS Zone"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DNS Zone","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"DNS zones hosted within a virtual network, used to resolve internal hostnames for nodes and services. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone","summary":"List a network's DNS zones","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dns-zone/listnetworkdnszones","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone","summary":"Create a DNS zone","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","summary":"Delete a DNS zone","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}","summary":"Update a DNS zone","prefix":{"name":"put","color":"put"},"badges":[],"link":"/dns-zone/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"DNS Record","link":"/dns-record","routeSlug":"/dns-record","items":[{"label":"List a network zone's DNS records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns-record/listnetworkdnsrecords","routeSlug":"/dns-record/listnetworkdnsrecords","metadata":{"seo":{"title":"List a network zone's DNS records","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkDnsRecords","name":"List a network zone's DNS records","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network zone's DNS records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","href":"/dns-record/listnetworkdnsrecords","openApiOperationId":"listNetworkDnsRecords","summary":"List a network zone's DNS records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260"}},"schemaId":"schema_260"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_260","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_260"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns-record/listnetworkdnsrecords"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record"},{"label":"Create a DNS record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","routeSlug":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","metadata":{"seo":{"title":"Create a DNS record","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a DNS record","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a DNS record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"schemaId":"components/schemas/VirtualNetworkDNSRecord","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post/requestBody","description":"DNS record configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","href":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","summary":"Create a DNS record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSRecord","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record"},{"label":"Delete a DNS record","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","routeSlug":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","metadata":{"seo":{"title":"Delete a DNS record","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a DNS record","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a DNS record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"recordType","in":"path","schemaId":"schema_240","description":"DNS record type","required":true},{"name":"recordName","in":"path","schemaId":"schema_240","description":"DNS record name","required":true},{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"recordType","in":"path","required":true,"schemaId":"schema_240"},{"name":"recordName","in":"path","required":true,"schemaId":"schema_240"},{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","href":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","summary":"Delete a DNS record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}"},{"label":"Update a DNS record","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","routeSlug":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","metadata":{"seo":{"title":"Update a DNS record","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a DNS record","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a DNS record","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"recordType","in":"path","schemaId":"schema_240","description":"DNS record type","required":true},{"name":"recordName","in":"path","schemaId":"schema_240","description":"DNS record name","required":true},{"name":"zoneName","in":"path","schemaId":"schema_240","description":"DNS zone name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"schemaId":"components/schemas/VirtualNetworkDNSRecord","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put/requestBody","description":"DNS record configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"recordType","in":"path","required":true,"schemaId":"schema_240"},{"name":"recordName","in":"path","required":true,"schemaId":"schema_240"},{"name":"zoneName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","href":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","summary":"Update a DNS record"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkDNSRecord","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkDNSRecord"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1dns-zone~1{zoneName}~1dns-record~1{recordName}~1{recordType}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}"}],"content":{"contentType":"group","meta":{"name":"DNS Record"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DNS Record","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Individual DNS A/CNAME records within a virtual network DNS zone. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","summary":"List a network zone's DNS records","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dns-record/listnetworkdnsrecords","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record","summary":"Create a DNS record","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","summary":"Delete a DNS record","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/dns-zone/{zoneName}/dns-record/{recordName}/{recordType}","summary":"Update a DNS record","prefix":{"name":"put","color":"put"},"badges":[],"link":"/dns-record/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1dns-zone~1{zonename}~1dns-record~1{recordname}~1{recordtype}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Network Group","link":"/network-group","routeSlug":"/network-group","items":[{"label":"List a network's groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-group/listnetworkgroups","routeSlug":"/network-group/listnetworkgroups","metadata":{"seo":{"title":"List a network's groups","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkGroups","name":"List a network's groups","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/network-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group","href":"/network-group/listnetworkgroups","openApiOperationId":"listNetworkGroups","summary":"List a network's groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261"}},"schemaId":"schema_261"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_261","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_261"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-group/listnetworkgroups"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group"},{"label":"Create a network group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","routeSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","metadata":{"seo":{"title":"Create a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"schemaId":"components/schemas/VirtualNetworkGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post/requestBody","description":"Network group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/network-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group","href":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","summary":"Create a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group"},{"label":"Delete a network group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","routeSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","metadata":{"seo":{"title":"Delete a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","href":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","summary":"Delete a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}"},{"label":"List a network's group memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-group/getnetworkgroup","routeSlug":"/network-group/getnetworkgroup","metadata":{"seo":{"title":"List a network's group memberships","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNetworkGroup","name":"List a network's group memberships","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's group memberships","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","href":"/network-group/getnetworkgroup","openApiOperationId":"getNetworkGroup","summary":"List a network's group memberships"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}},"schemaId":"schema_262"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_262","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_262"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-group/getnetworkgroup"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}"},{"label":"Update a network group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","routeSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","metadata":{"seo":{"title":"Update a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"schemaId":"components/schemas/VirtualNetworkGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put/requestBody","description":"Network group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","href":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","summary":"Update a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}"},{"label":"Remove a network object from a network group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","routeSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","metadata":{"seo":{"title":"Remove a network object from a network group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a network object from a network group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a network object from a network group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","href":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","summary":"Remove a network object from a network group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}"},{"label":"Add a network object to a network group (represented by a network group membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","routeSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","metadata":{"seo":{"title":"Add a network object to a network group (represented by a network group membership","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a network object to a network group (represented by a network group membership","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a network object to a network group (represented by a network group membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","href":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","summary":"Add a network object to a network group (represented by a network group membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-group~1{groupName}~1{objectName}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}"}],"content":{"contentType":"group","meta":{"name":"Network Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Network Group","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Named collections of network objects for use in access policies. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/network-group","summary":"List a network's groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/network-group/listnetworkgroups","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group","summary":"Create a network group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","summary":"Delete a network group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","summary":"List a network's group memberships","prefix":{"name":"get","color":"get"},"badges":[],"link":"/network-group/getnetworkgroup","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}","summary":"Update a network group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","summary":"Remove a network object from a network group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-group/{groupName}/{objectName}","summary":"Add a network object to a network group (represented by a network group membership","prefix":{"name":"post","color":"post"},"badges":[],"link":"/network-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-group~1{groupname}~1{objectname}/post","deprecated":false}]}]}]}]}},{"type":"group","label":"Network Object","link":"/network-object","routeSlug":"/network-object","items":[{"label":"List a network's objects","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-object/listnetworkobjects","routeSlug":"/network-object/listnetworkobjects","metadata":{"seo":{"title":"List a network's objects","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkObjects","name":"List a network's objects","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's objects","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/network-object","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object","href":"/network-object/listnetworkobjects","openApiOperationId":"listNetworkObjects","summary":"List a network's objects"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}},"schemaId":"schema_263"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_263","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_263"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-object/listnetworkobjects"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object"},{"label":"Create a network object","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","routeSlug":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","metadata":{"seo":{"title":"Create a network object","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network object","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"schemaId":"components/schemas/VirtualNetworkObject","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post/requestBody","description":"Network object configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/network-object","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object","href":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","summary":"Create a network object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object"},{"label":"Delete a network object","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","routeSlug":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","metadata":{"seo":{"title":"Delete a network object","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network object","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","href":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","summary":"Delete a network object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}"},{"label":"Update a network object","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","routeSlug":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","metadata":{"seo":{"title":"Update a network object","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network object","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network object","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"objectName","in":"path","schemaId":"schema_240","description":"Network object name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"schemaId":"components/schemas/VirtualNetworkObject","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put/requestBody","description":"Network object configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"objectName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","href":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","summary":"Update a network object"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkObject","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkObject"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1network-object~1{objectName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}"}],"content":{"contentType":"group","meta":{"name":"Network Object"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Network Object","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network objects (subnets, hosts, ranges) used as reusable references in access policies and routes. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/network-object","summary":"List a network's objects","prefix":{"name":"get","color":"get"},"badges":[],"link":"/network-object/listnetworkobjects","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object","summary":"Create a network object","prefix":{"name":"post","color":"post"},"badges":[],"link":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","summary":"Delete a network object","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/network-object/{objectName}","summary":"Update a network object","prefix":{"name":"put","color":"put"},"badges":[],"link":"/network-object/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1network-object~1{objectname}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Port Forwarding","link":"/port-forwarding","routeSlug":"/port-forwarding","items":[{"label":"List a network's port forwardings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/port-forwarding/listnetworkportforwardings","routeSlug":"/port-forwarding/listnetworkportforwardings","metadata":{"seo":{"title":"List a network's port forwardings","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkPortForwardings","name":"List a network's port forwardings","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's port forwardings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","href":"/port-forwarding/listnetworkportforwardings","openApiOperationId":"listNetworkPortForwardings","summary":"List a network's port forwardings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}},"schemaId":"schema_264"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_264","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_264"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/port-forwarding/listnetworkportforwardings"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding"},{"label":"Create a port forwarding","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","routeSlug":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","metadata":{"seo":{"title":"Create a port forwarding","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a port forwarding","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a port forwarding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"schemaId":"components/schemas/PortForwarding","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post/requestBody","description":"Port forwarding configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","href":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","summary":"Create a port forwarding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/PortForwarding","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding"},{"label":"Get a port forwarding","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","routeSlug":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","metadata":{"seo":{"title":"Get a port forwarding","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Get a port forwarding","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a port forwarding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portForwardingID","in":"path","schemaId":"schema_240","description":"Port forwarding ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"portForwardingID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","href":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","summary":"Get a port forwarding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"schemaId":"components/schemas/PortForwarding"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/PortForwarding","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PortForwarding"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}"},{"label":"Update a port forwarding","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","routeSlug":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","metadata":{"seo":{"title":"Update a port forwarding","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a port forwarding","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a port forwarding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"portForwardingID","in":"path","schemaId":"schema_240","description":"Port forwarding ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"schemaId":"components/schemas/PortForwarding","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put/requestBody","description":"Port forwarding configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"portForwardingID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","href":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","summary":"Update a port forwarding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/PortForwarding","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/PortForwarding"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1port-forwarding~1{portForwardingID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}"}],"content":{"contentType":"group","meta":{"name":"Port Forwarding"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Port Forwarding","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Port forwarding rules that expose node services through the virtual network to other nodes. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","summary":"List a network's port forwardings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/port-forwarding/listnetworkportforwardings","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding","summary":"Create a port forwarding","prefix":{"name":"post","color":"post"},"badges":[],"link":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","summary":"Get a port forwarding","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/port-forwarding/{portForwardingID}","summary":"Update a port forwarding","prefix":{"name":"put","color":"put"},"badges":[],"link":"/port-forwarding/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1port-forwarding~1{portforwardingid}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Route","link":"/route","routeSlug":"/route","items":[{"label":"Get default global vpn routes for a virtual network","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/route/listnetworkroutes","routeSlug":"/route/listnetworkroutes","metadata":{"seo":{"title":"Get default global vpn routes for a virtual network","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkRoutes","name":"Get default global vpn routes for a virtual network","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get default global vpn routes for a virtual network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route","href":"/route/listnetworkroutes","openApiOperationId":"listNetworkRoutes","summary":"Get default global vpn routes for a virtual network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}},"schemaId":"schema_265"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_265","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_265"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/route/listnetworkroutes"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route"},{"label":"Create a network route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","routeSlug":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","metadata":{"seo":{"title":"Create a network route","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network route","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"schemaId":"components/schemas/VirtualNetworkRoute","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post/requestBody","description":"Route configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route","href":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","summary":"Create a network route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkRoute","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route"},{"label":"Delete a network route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","routeSlug":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","metadata":{"seo":{"title":"Delete a network route","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network route","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"routeID","in":"path","schemaId":"schema_240","description":"Route ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"routeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","href":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","summary":"Delete a network route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}"},{"label":"Update a network route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","routeSlug":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","metadata":{"seo":{"title":"Update a network route","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network route","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"routeID","in":"path","schemaId":"schema_240","description":"Route ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"schemaId":"components/schemas/VirtualNetworkRoute","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put/requestBody","description":"Route configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"routeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","href":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","summary":"Update a network route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkRoute","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkRoute"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1route~1{routeID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}"}],"content":{"contentType":"group","meta":{"name":"Route"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Route","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static routes within a virtual network directing traffic between nodes and subnets. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/route","summary":"Get default global vpn routes for a virtual network","prefix":{"name":"get","color":"get"},"badges":[],"link":"/route/listnetworkroutes","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route","summary":"Create a network route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","summary":"Delete a network route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/route/{routeID}","summary":"Update a network route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/route/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1route~1{routeid}/put","deprecated":false}]}]}]}]}},{"type":"separator","label":"Cluster","content":null},{"type":"group","label":"Cluster","link":"/cluster","routeSlug":"/cluster","items":[{"label":"Retrieve all high-availability node clusters in the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/listclusters","routeSlug":"/cluster/listclusters","metadata":{"seo":{"title":"Retrieve all high-availability node clusters in the organization","description":"Retrieve all high-availability node clusters in the organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusters","name":"Retrieve all high-availability node clusters in the organization","isWebhook":false,"pointer":"/paths/~1cluster/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all high-availability node clusters in the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"withConfig","in":"query","schemaId":"schema_266","description":"If specified, clusters will return with their full config populated."}],"pointer":"/paths/~1cluster/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cluster","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"withConfig","in":"query","required":false,"schemaId":"schema_266"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cluster","href":"/cluster/listclusters","openApiOperationId":"listClusters","summary":"Retrieve all high-availability node clusters in the organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}},"schemaId":"schema_267"}],"pointer":"/paths/~1cluster/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_267","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_267"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/listclusters"}],"panels":[]}]},"httpPath":"/cluster"},{"label":"Create a new high-availability cluster for grouping nodes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster/post","routeSlug":"/cluster/paths/~1cluster/post","metadata":{"seo":{"title":"Create a new high-availability cluster for grouping nodes","description":"Create a new high-availability cluster for grouping nodes"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new high-availability cluster for grouping nodes","isWebhook":false,"pointer":"/paths/~1cluster/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new high-availability cluster for grouping nodes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateClusterModel"}},"schemaId":"components/schemas/CreateClusterModel","pointer":"/paths/~1cluster/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/cluster","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateClusterModel"}},"responseCodes":["200","422"],"pointer":"/cluster","href":"/cluster/paths/~1cluster/post","summary":"Create a new high-availability cluster for grouping nodes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/CreateClusterModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateClusterModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1cluster/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster/post"}],"panels":[]}]},"httpPath":"/cluster"},{"label":"Permanently remove a cluster and all its configurations","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}/delete","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}/delete","metadata":{"seo":{"title":"Permanently remove a cluster and all its configurations","description":"Permanently remove a cluster and all its configurations"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Permanently remove a cluster and all its configurations","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permanently remove a cluster and all its configurations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cluster/{clusterFQDN}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/cluster/{clusterFQDN}","href":"/cluster/paths/~1cluster~1{clusterfqdn}/delete","summary":"Permanently remove a cluster and all its configurations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1cluster~1{clusterFQDN}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}/delete"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}"},{"label":"Retrieve detailed configuration and status of a specific cluster","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/getcluster","routeSlug":"/cluster/getcluster","metadata":{"seo":{"title":"Retrieve detailed configuration and status of a specific cluster","description":"Retrieve detailed configuration and status of a specific cluster"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCluster","name":"Retrieve detailed configuration and status of a specific cluster","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed configuration and status of a specific cluster","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/cluster/{clusterFQDN}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/cluster/{clusterFQDN}","href":"/cluster/getcluster","openApiOperationId":"getCluster","summary":"Retrieve detailed configuration and status of a specific cluster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClusterModel"}},"schemaId":"components/schemas/ClusterModel"},{"code":"404","description":"Cluster not found"}],"pointer":"/paths/~1cluster~1{clusterFQDN}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ClusterModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ClusterModel"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/getcluster"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}"},{"label":"Modify cluster configuration and failover settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}/put","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}/put","metadata":{"seo":{"title":"Modify cluster configuration and failover settings","description":"Modify cluster configuration and failover settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify cluster configuration and failover settings","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify cluster configuration and failover settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClusterModel"}},"schemaId":"components/schemas/ClusterModel","pointer":"/paths/~1cluster~1{clusterFQDN}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cluster/{clusterFQDN}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ClusterModel"}},"responseCodes":["200","422"],"pointer":"/cluster/{clusterFQDN}","href":"/cluster/paths/~1cluster~1{clusterfqdn}/put","summary":"Modify cluster configuration and failover settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ClusterModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ClusterModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1cluster~1{clusterFQDN}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}/put"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}"},{"label":"Manually promote a specific node to be the active member in an HA cluster","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}~1active~1{nodeid}/put","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1active~1{nodeid}/put","metadata":{"seo":{"title":"Manually promote a specific node to be the active member in an HA cluster","description":"Manually promote a specific node to be the active member in an HA cluster"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Manually promote a specific node to be the active member in an HA cluster","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}~1active~1{nodeID}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manually promote a specific node to be the active member in an HA cluster","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1active~1{nodeID}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cluster/{clusterFQDN}/active/{nodeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/cluster/{clusterFQDN}/active/{nodeID}","href":"/cluster/paths/~1cluster~1{clusterfqdn}~1active~1{nodeid}/put","summary":"Manually promote a specific node to be the active member in an HA cluster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1active~1{nodeID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1active~1{nodeid}/put"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}/active/{nodeID}"},{"label":"Update connectors configuration for a cluster\n","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/put","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/put","metadata":{"seo":{"title":"Update connectors configuration for a cluster\n","description":"Requires node::configure::connectors permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update connectors configuration for a cluster\n","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1connectors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update connectors configuration for a cluster\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1connectors/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectorConfig"}},"schemaId":"components/schemas/ConnectorConfig","pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1connectors/put/requestBody","description":"Config body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cluster/{clusterFQDN}/config/connectors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectorConfig"}},"responseCodes":["200","422"],"pointer":"/cluster/{clusterFQDN}/config/connectors","href":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/put","summary":"Update connectors configuration for a cluster\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ConnectorConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectorConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1connectors/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/put"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}/config/connectors"},{"label":"Delete the connector config for a cluster\n","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/delete","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/delete","metadata":{"seo":{"title":"Delete the connector config for a cluster\n","description":"Requires node::configure::connectors permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete the connector config for a cluster\n","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1connectors/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete the connector config for a cluster\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1connectors/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cluster/{clusterFQDN}/config/connectors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cluster/{clusterFQDN}/config/connectors","href":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/delete","summary":"Delete the connector config for a cluster\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1connectors/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/delete"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}/config/connectors"},{"label":"Add a connector to a cluster. Requires V2 connector config.\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors/post","routeSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors/post","metadata":{"seo":{"title":"Add a connector to a cluster. Requires V2 connector config.\n","description":"Requires node::configure::connectors permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a connector to a cluster. Requires V2 connector config.\n","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a connector to a cluster. Requires V2 connector config.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"schemaId":"components/schemas/EdgeConnector","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors/post/requestBody","description":"Connector"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/config/connectors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/config/connectors","href":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors/post","summary":"Add a connector to a cluster. Requires V2 connector config.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeConnector","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/config/connectors"},{"label":"Upgrade a cluster's connector config to V2.\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1upgrade/post","routeSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1upgrade/post","metadata":{"seo":{"title":"Upgrade a cluster's connector config to V2.\n","description":"Requires node::configure::connectors permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upgrade a cluster's connector config to V2.\n","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1upgrade/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upgrade a cluster's connector config to V2.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1upgrade/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/config/connectors/upgrade","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/config/connectors/upgrade","href":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1upgrade/post","summary":"Upgrade a cluster's connector config to V2.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1upgrade/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1upgrade/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/config/connectors/upgrade"},{"label":"Update a connector on a cluster\n","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/put","routeSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/put","metadata":{"seo":{"title":"Update a connector on a cluster\n","description":"Requires V2 connector config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a connector on a cluster\n","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1{connectorID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a connector on a cluster\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires V2 connector config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"connectorID","in":"path","schemaId":"schema_240","description":"Connector ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1{connectorID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"schemaId":"components/schemas/EdgeConnector","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1{connectorID}/put/requestBody","description":"Connector"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/config/connectors/{connectorID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"connectorID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/config/connectors/{connectorID}","href":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/put","summary":"Update a connector on a cluster\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeConnector","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1{connectorID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/config/connectors/{connectorID}"},{"label":"Delete a connector from a cluster. Requires V2 connector config.\n","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/delete","routeSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/delete","metadata":{"seo":{"title":"Delete a connector from a cluster. Requires V2 connector config.\n","description":"Requires node::configure::connectors permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a connector from a cluster. Requires V2 connector config.\n","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1{connectorID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a connector from a cluster. Requires V2 connector config.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"connectorID","in":"path","schemaId":"schema_240","description":"Connector ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1{connectorID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/config/connectors/{connectorID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"connectorID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/config/connectors/{connectorID}","href":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/delete","summary":"Delete a connector from a cluster. Requires V2 connector config.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1connectors~1{connectorID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/config/connectors/{connectorID}"},{"label":"Update network configuration for a cluster\n","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1network/put","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1network/put","metadata":{"seo":{"title":"Update network configuration for a cluster\n","description":"Requires node::configure:network permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update network configuration for a cluster\n","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1network/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update network configuration for a cluster\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1network/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_268"}},"schemaId":"schema_268","pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1network/put/requestBody","description":"Network Config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cluster/{clusterFQDN}/config/network","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_268"}},"responseCodes":["200","422"],"pointer":"/cluster/{clusterFQDN}/config/network","href":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1network/put","summary":"Update network configuration for a cluster\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_268","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_268"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1network/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1network/put"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}/config/network"},{"label":"Update services configuration for a cluster.\n","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/put","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/put","metadata":{"seo":{"title":"Update services configuration for a cluster.\n","description":"Requires nodes::configure::services permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update services configuration for a cluster.\n","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1services/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update services configuration for a cluster.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1services/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceConfig"}},"schemaId":"components/schemas/ServiceConfig","pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1services/put/requestBody","description":"Config body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cluster/{clusterFQDN}/config/services","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceConfig"}},"responseCodes":["200","422"],"pointer":"/cluster/{clusterFQDN}/config/services","href":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/put","summary":"Update services configuration for a cluster.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ServiceConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1services/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/put"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}/config/services"},{"label":"Remove a cluster's services configuration.\n","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/delete","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/delete","metadata":{"seo":{"title":"Remove a cluster's services configuration.\n","description":"Requires nodes::configure::services permissions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a cluster's services configuration.\n","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1services/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a cluster's services configuration.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1services/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cluster/{clusterFQDN}/config/services","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cluster/{clusterFQDN}/config/services","href":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/delete","summary":"Remove a cluster's services configuration.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1config~1services/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/delete"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}/config/services"},{"label":"Add a service to a cluster. Requires V2 services config.\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services/post","routeSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services/post","metadata":{"seo":{"title":"Add a service to a cluster. Requires V2 services config.\n","description":"Requires node::configure::services permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a service to a cluster. Requires V2 services config.\n","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a service to a cluster. Requires V2 services config.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"schemaId":"components/schemas/EdgeService","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services/post/requestBody","description":"Service"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/config/services","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/config/services","href":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services/post","summary":"Add a service to a cluster. Requires V2 services config.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeService","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/config/services"},{"label":"Upgrade a cluster's services config to V2.\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1upgrade/post","routeSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1upgrade/post","metadata":{"seo":{"title":"Upgrade a cluster's services config to V2.\n","description":"Requires node::configure::services permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upgrade a cluster's services config to V2.\n","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1upgrade/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upgrade a cluster's services config to V2.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1upgrade/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/config/services/upgrade","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/config/services/upgrade","href":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1upgrade/post","summary":"Upgrade a cluster's services config to V2.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1upgrade/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1upgrade/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/config/services/upgrade"},{"label":"Update a service on a cluster.\n","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/put","routeSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/put","metadata":{"seo":{"title":"Update a service on a cluster.\n","description":"Requires V2 services config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a service on a cluster.\n","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1{serviceID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a service on a cluster.\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires V2 services config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"serviceID","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1{serviceID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"schemaId":"components/schemas/EdgeService","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1{serviceID}/put/requestBody","description":"Service"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/config/services/{serviceID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"serviceID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/config/services/{serviceID}","href":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/put","summary":"Update a service on a cluster.\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeService","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1{serviceID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/config/services/{serviceID}"},{"label":"Delete a service from a cluster\n","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/delete","routeSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/delete","metadata":{"seo":{"title":"Delete a service from a cluster\n","description":"Requires V2 services config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a service from a cluster\n","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1{serviceID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a service from a cluster\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires V2 services config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"serviceID","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1{serviceID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/config/services/{serviceID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"serviceID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/config/services/{serviceID}","href":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/delete","summary":"Delete a service from a cluster\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1config~1services~1{serviceID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/config/services/{serviceID}"},{"label":"Delete a tag from a cluster","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/delete","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/delete","metadata":{"seo":{"title":"Delete a tag from a cluster","description":"Delete a tag from a cluster"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a tag from a cluster","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}~1tag~1{tagName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a tag from a cluster","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"tagName","in":"path","schemaId":"schema_240","description":"Tag name","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1tag~1{tagName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/cluster/{clusterFQDN}/tag/{tagName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"tagName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/cluster/{clusterFQDN}/tag/{tagName}","href":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/delete","summary":"Delete a tag from a cluster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1tag~1{tagName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/delete"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}/tag/{tagName}"},{"label":"Set a tag on a cluster","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/put","routeSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/put","metadata":{"seo":{"title":"Set a tag on a cluster","description":"Set a tag on a cluster"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Set a tag on a cluster","isWebhook":false,"pointer":"/paths/~1cluster~1{clusterFQDN}~1tag~1{tagName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set a tag on a cluster","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"tagName","in":"path","schemaId":"schema_240","description":"Tag name","required":true}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1tag~1{tagName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagValueModel"}},"schemaId":"components/schemas/TagValueModel","pointer":"/paths/~1cluster~1{clusterFQDN}~1tag~1{tagName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/cluster/{clusterFQDN}/tag/{tagName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"tagName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagValueModel"}},"responseCodes":["200"],"pointer":"/cluster/{clusterFQDN}/tag/{tagName}","href":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/put","summary":"Set a tag on a cluster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/TagValueModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagValueModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1cluster~1{clusterFQDN}~1tag~1{tagName}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/put"}],"panels":[]}]},"httpPath":"/cluster/{clusterFQDN}/tag/{tagName}"}],"content":{"contentType":"group","meta":{"name":"Cluster"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cluster","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/clusters/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Clusters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" group nodes for high availability and shared configuration. Changes applied to a cluster propagate to all member nodes. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/cluster","summary":"Retrieve all high-availability node clusters in the organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster/listclusters","deprecated":false},{"title":"/cluster","summary":"Create a new high-availability cluster for grouping nodes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster/paths/~1cluster/post","deprecated":false},{"title":"/cluster/{clusterFQDN}","summary":"Permanently remove a cluster and all its configurations","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}/delete","deprecated":false},{"title":"/cluster/{clusterFQDN}","summary":"Retrieve detailed configuration and status of a specific cluster","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster/getcluster","deprecated":false},{"title":"/cluster/{clusterFQDN}","summary":"Modify cluster configuration and failover settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}/put","deprecated":false},{"title":"/cluster/{clusterFQDN}/active/{nodeID}","summary":"Manually promote a specific node to be the active member in an HA cluster","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}~1active~1{nodeid}/put","deprecated":false},{"title":"/cluster/{clusterFQDN}/config/connectors","summary":"Update connectors configuration for a cluster\n","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/put","deprecated":false},{"title":"/cluster/{clusterFQDN}/config/connectors","summary":"Delete the connector config for a cluster\n","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1connectors/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/config/connectors","summary":"Add a connector to a cluster. Requires V2 connector config.\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/config/connectors/upgrade","summary":"Upgrade a cluster's connector config to V2.\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1upgrade/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/config/connectors/{connectorID}","summary":"Update a connector on a cluster\n","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/config/connectors/{connectorID}","summary":"Delete a connector from a cluster. Requires V2 connector config.\n","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1connectors~1{connectorid}/delete","deprecated":false},{"title":"/cluster/{clusterFQDN}/config/network","summary":"Update network configuration for a cluster\n","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1network/put","deprecated":false},{"title":"/cluster/{clusterFQDN}/config/services","summary":"Update services configuration for a cluster.\n","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/put","deprecated":false},{"title":"/cluster/{clusterFQDN}/config/services","summary":"Remove a cluster's services configuration.\n","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}~1config~1services/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/config/services","summary":"Add a service to a cluster. Requires V2 services config.\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/config/services/upgrade","summary":"Upgrade a cluster's services config to V2.\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1upgrade/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/config/services/{serviceID}","summary":"Update a service on a cluster.\n","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/config/services/{serviceID}","summary":"Delete a service from a cluster\n","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster/paths/~1v2~1cluster~1{clusterfqdn}~1config~1services~1{serviceid}/delete","deprecated":false},{"title":"/cluster/{clusterFQDN}/tag/{tagName}","summary":"Delete a tag from a cluster","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/delete","deprecated":false},{"title":"/cluster/{clusterFQDN}/tag/{tagName}","summary":"Set a tag on a cluster","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster/paths/~1cluster~1{clusterfqdn}~1tag~1{tagname}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"VPN","link":"/cluster-greater-vpn","routeSlug":"/cluster-greater-vpn","items":[{"label":"List all VPN networks attached to a cluster, including IP assignments and routing","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/listclustervpnnetworks","routeSlug":"/cluster-greater-vpn/listclustervpnnetworks","metadata":{"seo":{"title":"List all VPN networks attached to a cluster, including IP assignments and routing","description":"List all VPN networks attached to a cluster, including IP assignments and routing"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterVpnNetworks","name":"List all VPN networks attached to a cluster, including IP assignments and routing","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all VPN networks attached to a cluster, including IP assignments and routing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/vpn","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn","href":"/cluster-greater-vpn/listclustervpnnetworks","openApiOperationId":"listClusterVpnNetworks","summary":"List all VPN networks attached to a cluster, including IP assignments and routing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_269"}},"schemaId":"schema_269"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_269","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_269"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/listclustervpnnetworks"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn"},{"label":"Attach a VPN network","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn/post","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn/post","metadata":{"seo":{"title":"Attach a VPN network","description":"Attach a VPN network"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Attach a VPN network","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach a VPN network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"schemaId":"components/schemas/VpnNetworkUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/vpn","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn/post","summary":"Attach a VPN network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnNetworkUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnClusterNetworkInventoryModel"}},"schemaId":"components/schemas/VpnClusterNetworkInventoryModel"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VpnClusterNetworkInventoryModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnClusterNetworkInventoryModel"}}},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn"},{"label":"Delete a VPN network","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/delete","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/delete","metadata":{"seo":{"title":"Delete a VPN network","description":"Delete a VPN network"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN network","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/delete","summary":"Delete a VPN network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}"},{"label":"Get full details of a VPN network on a cluster, including routes, services, interfaces, and DNS","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/getclustervpnnetwork","routeSlug":"/cluster-greater-vpn/getclustervpnnetwork","metadata":{"seo":{"title":"Get full details of a VPN network on a cluster, including routes, services, interfaces, and DNS","description":"Get full details of a VPN network on a cluster, including routes, services, interfaces, and DNS"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClusterVpnNetwork","name":"Get full details of a VPN network on a cluster, including routes, services, interfaces, and DNS","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get full details of a VPN network on a cluster, including routes, services, interfaces, and DNS","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}","href":"/cluster-greater-vpn/getclustervpnnetwork","openApiOperationId":"getClusterVpnNetwork","summary":"Get full details of a VPN network on a cluster, including routes, services, interfaces, and DNS"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnClusterNetworkInventoryModel"}},"schemaId":"components/schemas/VpnClusterNetworkInventoryModel"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VpnClusterNetworkInventoryModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnClusterNetworkInventoryModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/getclustervpnnetwork"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}"},{"label":"Update a VPN network","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/put","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/put","metadata":{"seo":{"title":"Update a VPN network","description":"Update a VPN network"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN network","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"schemaId":"components/schemas/VpnNetworkUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/put","summary":"Update a VPN network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnNetworkUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}"},{"label":"Delete a VPN DNS configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/delete","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/delete","metadata":{"seo":{"title":"Delete a VPN DNS configuration","description":"Delete a VPN DNS configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/delete","summary":"Delete a VPN DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns"},{"label":"Get a VPN DNS configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/getclustervpndns","routeSlug":"/cluster-greater-vpn/getclustervpndns","metadata":{"seo":{"title":"Get a VPN DNS configuration","description":"Get a VPN DNS configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClusterVpnDns","name":"Get a VPN DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a VPN DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","href":"/cluster-greater-vpn/getclustervpndns","openApiOperationId":"getClusterVpnDns","summary":"Get a VPN DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnClusterDnsModel"}},"schemaId":"components/schemas/VpnClusterDnsModel"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VpnClusterDnsModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnClusterDnsModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/getclustervpndns"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns"},{"label":"Create a VPN DNS configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/post","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/post","metadata":{"seo":{"title":"Create a VPN DNS configuration","description":"Create a VPN DNS configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"schemaId":"components/schemas/VpnDnsUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/post","summary":"Create a VPN DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnDnsUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns"},{"label":"Update a VPN DNS configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/put","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/put","metadata":{"seo":{"title":"Update a VPN DNS configuration","description":"Update a VPN DNS configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"schemaId":"components/schemas/VpnDnsUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/put","summary":"Update a VPN DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnDnsUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dns/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns"},{"label":"Get dynamic routes exported by a cluster","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/listclustervpnexportroutes","routeSlug":"/cluster-greater-vpn/listclustervpnexportroutes","metadata":{"seo":{"title":"Get dynamic routes exported by a cluster","description":"Get dynamic routes exported by a cluster"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterVpnExportRoutes","name":"Get dynamic routes exported by a cluster","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get dynamic routes exported by a cluster","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route","href":"/cluster-greater-vpn/listclustervpnexportroutes","openApiOperationId":"listClusterVpnExportRoutes","summary":"Get dynamic routes exported by a cluster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}},"schemaId":"schema_270"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_270","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/listclustervpnexportroutes"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route"},{"label":"Create a VPN export route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route/post","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route/post","metadata":{"seo":{"title":"Create a VPN export route","description":"Create a VPN export route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN export route","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN export route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route/post","summary":"Create a VPN export route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route"},{"label":"Delete a VPN export route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete","metadata":{"seo":{"title":"Delete a VPN export route","description":"Delete a VPN export route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN export route","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN export route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route/{uid}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete","summary":"Delete a VPN export route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route/{uid}"},{"label":"Update a VPN export route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put","metadata":{"seo":{"title":"Update a VPN export route","description":"Update a VPN export route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN export route","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN export route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route/{uid}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put","summary":"Update a VPN export route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route/{uid}"},{"label":"Get dynamic routes imported by a cluster","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/listclustervpnimportroutes","routeSlug":"/cluster-greater-vpn/listclustervpnimportroutes","metadata":{"seo":{"title":"Get dynamic routes imported by a cluster","description":"Get dynamic routes imported by a cluster"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterVpnImportRoutes","name":"Get dynamic routes imported by a cluster","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get dynamic routes imported by a cluster","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route","href":"/cluster-greater-vpn/listclustervpnimportroutes","openApiOperationId":"listClusterVpnImportRoutes","summary":"Get dynamic routes imported by a cluster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}},"schemaId":"schema_270"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_270","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/listclustervpnimportroutes"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route"},{"label":"Create a VPN import route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route/post","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route/post","metadata":{"seo":{"title":"Create a VPN import route","description":"Create a VPN import route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN import route","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN import route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route/post","summary":"Create a VPN import route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route"},{"label":"Delete a VPN import route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete","metadata":{"seo":{"title":"Delete a VPN import route","description":"Delete a VPN import route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN import route","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN import route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route/{uid}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete","summary":"Delete a VPN import route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route/{uid}"},{"label":"Update a VPN import route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put","metadata":{"seo":{"title":"Update a VPN import route","description":"Update a VPN import route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN import route","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN import route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route/{uid}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put","summary":"Update a VPN import route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route/{uid}"},{"label":"Get a VPN's interfaces","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/listclustervpninterfaces","routeSlug":"/cluster-greater-vpn/listclustervpninterfaces","metadata":{"seo":{"title":"Get a VPN's interfaces","description":"Get the list of interfaces attached to a VPN network on a cluster. Note: NATs within a VPN interface can share the same source and destination CIDRs provided they are differentiated by route metric. This is intentional and not a configuration error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterVpnInterfaces","name":"Get a VPN's interfaces","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a VPN's interfaces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the list of interfaces attached to a VPN network on a cluster. Note: NATs within a VPN interface can share the same source and destination CIDRs provided they are differentiated by route metric. This is intentional and not a configuration error."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface","href":"/cluster-greater-vpn/listclustervpninterfaces","openApiOperationId":"listClusterVpnInterfaces","summary":"Get a VPN's interfaces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_271"}},"schemaId":"schema_271"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_271","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_271"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/listclustervpninterfaces"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface"},{"label":"Create a VPN interface","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface/post","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface/post","metadata":{"seo":{"title":"Create a VPN interface","description":"inDefaultRoute and outDefaultRoute are mutually exclusive — set at most one to true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN interface","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN interface","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDefaultRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outDefaultRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mutually exclusive — set at most one to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inside NATs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insideNats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rewrite traffic arriving from the VPN before it enters the local network."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outside NATs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outsideNats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rewrite traffic leaving the local network before it enters the VPN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After creating or updating a VPN interface, push the cluster config for the change to take effect."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"schemaId":"components/schemas/VpnInterfaceUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface/post","summary":"Create a VPN interface"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnInterfaceUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface"},{"label":"Delete a VPN interface","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/delete","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/delete","metadata":{"seo":{"title":"Delete a VPN interface","description":"Delete a VPN interface"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN interface","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface~1{interfaceName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN interface","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"interfaceName","in":"path","schemaId":"schema_240","description":"Interface name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface~1{interfaceName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface/{interfaceName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"interfaceName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface/{interfaceName}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/delete","summary":"Delete a VPN interface"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface~1{interfaceName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface/{interfaceName}"},{"label":"Update a VPN interface","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/put","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/put","metadata":{"seo":{"title":"Update a VPN interface","description":"inDefaultRoute and outDefaultRoute are mutually exclusive — set at most one to true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN interface","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface~1{interfaceName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN interface","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDefaultRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outDefaultRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mutually exclusive — set at most one to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inside NATs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insideNats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rewrite traffic arriving from the VPN before it enters the local network."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outside NATs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outsideNats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rewrite traffic leaving the local network before it enters the VPN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After creating or updating a VPN interface, push the cluster config for the change to take effect."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"interfaceName","in":"path","schemaId":"schema_240","description":"Interface name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface~1{interfaceName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"schemaId":"components/schemas/VpnInterfaceUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface~1{interfaceName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface/{interfaceName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"interfaceName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface/{interfaceName}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/put","summary":"Update a VPN interface"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnInterfaceUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1interface~1{interfaceName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface/{interfaceName}"},{"label":"Get local vpn routes for a customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/listclustervpnroutes","routeSlug":"/cluster-greater-vpn/listclustervpnroutes","metadata":{"seo":{"title":"Get local vpn routes for a customer","description":"Get local vpn routes for a customer"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterVpnRoutes","name":"Get local vpn routes for a customer","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get local vpn routes for a customer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route","href":"/cluster-greater-vpn/listclustervpnroutes","openApiOperationId":"listClusterVpnRoutes","summary":"Get local vpn routes for a customer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}},"schemaId":"schema_270"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_270","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_270"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/listclustervpnroutes"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route"},{"label":"Create a VPN route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route/post","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route/post","metadata":{"seo":{"title":"Create a VPN route","description":"Create a VPN route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN route","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route/post","summary":"Create a VPN route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route"},{"label":"Delete a VPN route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/delete","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/delete","metadata":{"seo":{"title":"Delete a VPN route","description":"Delete a VPN route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN route","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route/{uid}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/delete","summary":"Delete a VPN route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route/{uid}"},{"label":"Update a VPN route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/put","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/put","metadata":{"seo":{"title":"Update a VPN route","description":"Update a VPN route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN route","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route/{uid}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/put","summary":"Update a VPN route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1route~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route/{uid}"},{"label":"Get a VPN's services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/listclustervpnservices","routeSlug":"/cluster-greater-vpn/listclustervpnservices","metadata":{"seo":{"title":"Get a VPN's services","description":"Get a VPN's services"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterVpnServices","name":"Get a VPN's services","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a VPN's services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service","href":"/cluster-greater-vpn/listclustervpnservices","openApiOperationId":"listClusterVpnServices","summary":"Get a VPN's services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272"}},"schemaId":"schema_272"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_272","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_272"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/listclustervpnservices"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service"},{"label":"Create a VPN Service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service/post","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service/post","metadata":{"seo":{"title":"Create a VPN Service","description":"Create a VPN Service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN Service","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"schemaId":"components/schemas/VpnServiceUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service/post","summary":"Create a VPN Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnServiceUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service"},{"label":"Delete a Service","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/delete","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/delete","metadata":{"seo":{"title":"Delete a Service","description":"Delete a Service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a Service","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service/{uid}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/delete","summary":"Delete a Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service/{uid}"},{"label":"Update a Service","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/put","routeSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/put","metadata":{"seo":{"title":"Update a Service","description":"Update a Service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a Service","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Cluster FQDN","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"schemaId":"components/schemas/VpnServiceUpdateModel","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service/{uid}","href":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/put","summary":"Update a Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnServiceUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1vpn~1{networkName}~1service~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service/{uid}"}],"content":{"contentType":"group","meta":{"name":"Cluster > VPN"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VPN","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-cluster attachment to virtual networks. Configure which virtual networks a cluster participates in and its VPN interface settings. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-vpn::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/cluster/{clusterFQDN}/vpn","summary":"List all VPN networks attached to a cluster, including IP assignments and routing","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-vpn/listclustervpnnetworks","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn","summary":"Attach a VPN network","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}","summary":"Delete a VPN network","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}","summary":"Get full details of a VPN network on a cluster, including routes, services, interfaces, and DNS","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-vpn/getclustervpnnetwork","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}","summary":"Update a VPN network","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","summary":"Delete a VPN DNS configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","summary":"Get a VPN DNS configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-vpn/getclustervpndns","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","summary":"Create a VPN DNS configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dns","summary":"Update a VPN DNS configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dns/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route","summary":"Get dynamic routes exported by a cluster","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-vpn/listclustervpnexportroutes","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route","summary":"Create a VPN export route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route/{uid}","summary":"Delete a VPN export route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/export-route/{uid}","summary":"Update a VPN export route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route","summary":"Get dynamic routes imported by a cluster","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-vpn/listclustervpnimportroutes","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route","summary":"Create a VPN import route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route/{uid}","summary":"Delete a VPN import route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/dynamic/import-route/{uid}","summary":"Update a VPN import route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface","summary":"Get a VPN's interfaces","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-vpn/listclustervpninterfaces","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface","summary":"Create a VPN interface","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface/{interfaceName}","summary":"Delete a VPN interface","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/interface/{interfaceName}","summary":"Update a VPN interface","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1interface~1{interfacename}/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route","summary":"Get local vpn routes for a customer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-vpn/listclustervpnroutes","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route","summary":"Create a VPN route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route/{uid}","summary":"Delete a VPN route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/route/{uid}","summary":"Update a VPN route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1route~1{uid}/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service","summary":"Get a VPN's services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-vpn/listclustervpnservices","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service","summary":"Create a VPN Service","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service/{uid}","summary":"Delete a Service","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/vpn/{networkName}/service/{uid}","summary":"Update a Service","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster-greater-vpn/paths/~1v2~1cluster~1{clusterfqdn}~1vpn~1{networkname}~1service~1{uid}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Compute","link":"/cluster-greater-compute","routeSlug":"/cluster-greater-compute","items":[{"label":"Retrieve all edge computing containers running on a cluster","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/listclustercontainers","routeSlug":"/cluster-greater-compute/listclustercontainers","metadata":{"seo":{"title":"Retrieve all edge computing containers running on a cluster","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterContainers","name":"Retrieve all edge computing containers running on a cluster","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all edge computing containers running on a cluster","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container","href":"/cluster-greater-compute/listclustercontainers","openApiOperationId":"listClusterContainers","summary":"Retrieve all edge computing containers running on a cluster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273"}},"schemaId":"schema_273"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_273","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/listclustercontainers"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container"},{"label":"Deploy a new containerized application to run on the cluster","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container/post","routeSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container/post","metadata":{"seo":{"title":"Deploy a new containerized application to run on the cluster","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Deploy a new containerized application to run on the cluster","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deploy a new containerized application to run on the cluster","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Container"}},"schemaId":"components/schemas/Container","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container/post/requestBody","description":"Container"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/exec/container","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Container"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container","href":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container/post","summary":"Deploy a new containerized application to run on the cluster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Container","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Container"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container"},{"label":"Remove a containerized application from the cluster and stop execution","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/delete","routeSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/delete","metadata":{"seo":{"title":"Remove a containerized application from the cluster and stop execution","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a containerized application from the cluster and stop execution","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a containerized application from the cluster and stop execution","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}","href":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/delete","summary":"Remove a containerized application from the cluster and stop execution"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}"},{"label":"Get edge compute container configuration on a cluster","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/getclustercontainer","routeSlug":"/cluster-greater-compute/getclustercontainer","metadata":{"seo":{"title":"Get edge compute container configuration on a cluster","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClusterContainer","name":"Get edge compute container configuration on a cluster","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get edge compute container configuration on a cluster","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}","href":"/cluster-greater-compute/getclustercontainer","openApiOperationId":"getClusterContainer","summary":"Get edge compute container configuration on a cluster"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Container"}},"schemaId":"components/schemas/Container"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Container","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Container"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/getclustercontainer"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}"},{"label":"Update a container","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/put","routeSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/put","metadata":{"seo":{"title":"Update a container","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a container","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a container","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Container"}},"schemaId":"components/schemas/Container","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/put/requestBody","description":"Container"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Container"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}","href":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/put","summary":"Update a container"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Container","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Container"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}"},{"label":"Retrieve security capabilities and permissions for a container","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/getclustercontainercapabilities","routeSlug":"/cluster-greater-compute/getclustercontainercapabilities","metadata":{"seo":{"title":"Retrieve security capabilities and permissions for a container","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClusterContainerCapabilities","name":"Retrieve security capabilities and permissions for a container","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1capability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve security capabilities and permissions for a container","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1capability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/capability","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/capability","href":"/cluster-greater-compute/getclustercontainercapabilities","openApiOperationId":"getClusterContainerCapabilities","summary":"Retrieve security capabilities and permissions for a container"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerCapabilities"}},"schemaId":"components/schemas/ContainerCapabilities"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1capability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerCapabilities","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerCapabilities"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/getclustercontainercapabilities"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/capability"},{"label":"Update container config","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}~1config/put","routeSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}~1config/put","metadata":{"seo":{"title":"Update container config","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update container config","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1config/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update container config","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1config/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContainerConfig"}},"schemaId":"components/schemas/ContainerConfig","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1config/put/requestBody","description":"Container config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/config","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContainerConfig"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/config","href":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}~1config/put","summary":"Update container config"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ContainerConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContainerConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1config/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}~1config/put"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/config"},{"label":"Get container health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/getclustercontainerhealthcheck","routeSlug":"/cluster-greater-compute/getclustercontainerhealthcheck","metadata":{"seo":{"title":"Get container health check","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClusterContainerHealthCheck","name":"Get container health check","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1healthcheck/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get container health check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1healthcheck/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/healthcheck","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/healthcheck","href":"/cluster-greater-compute/getclustercontainerhealthcheck","openApiOperationId":"getClusterContainerHealthCheck","summary":"Get container health check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerHealthCheck"}},"schemaId":"components/schemas/ContainerHealthCheck"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1healthcheck/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerHealthCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerHealthCheck"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/getclustercontainerhealthcheck"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/healthcheck"},{"label":"List container interfaces","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/listclustercontainerinterfaces","routeSlug":"/cluster-greater-compute/listclustercontainerinterfaces","metadata":{"seo":{"title":"List container interfaces","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterContainerInterfaces","name":"List container interfaces","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1interface/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container interfaces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1interface/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/interface","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/interface","href":"/cluster-greater-compute/listclustercontainerinterfaces","openApiOperationId":"listClusterContainerInterfaces","summary":"List container interfaces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_274"}},"schemaId":"schema_274"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1interface/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_274","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_274"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/listclustercontainerinterfaces"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/interface"},{"label":"List container limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/listclustercontainerlimits","routeSlug":"/cluster-greater-compute/listclustercontainerlimits","metadata":{"seo":{"title":"List container limits","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterContainerLimits","name":"List container limits","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1limit/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1limit/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/limit","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/limit","href":"/cluster-greater-compute/listclustercontainerlimits","openApiOperationId":"listClusterContainerLimits","summary":"List container limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerLimits"}},"schemaId":"components/schemas/ContainerLimits"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1limit/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerLimits","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerLimits"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/listclustercontainerlimits"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/limit"},{"label":"Get container logging configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/getclustercontainerlogging","routeSlug":"/cluster-greater-compute/getclustercontainerlogging","metadata":{"seo":{"title":"Get container logging configuration","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClusterContainerLogging","name":"Get container logging configuration","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1logging/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get container logging configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1logging/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/logging","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/logging","href":"/cluster-greater-compute/getclustercontainerlogging","openApiOperationId":"getClusterContainerLogging","summary":"Get container logging configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerLogging"}},"schemaId":"components/schemas/ContainerLogging"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1logging/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerLogging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerLogging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/getclustercontainerlogging"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/logging"},{"label":"List container mounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/listclustercontainermounts","routeSlug":"/cluster-greater-compute/listclustercontainermounts","metadata":{"seo":{"title":"List container mounts","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterContainerMounts","name":"List container mounts","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1mount/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container mounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1mount/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/mount","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/mount","href":"/cluster-greater-compute/listclustercontainermounts","openApiOperationId":"listClusterContainerMounts","summary":"List container mounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}},"schemaId":"schema_275"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1mount/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_275","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/listclustercontainermounts"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/mount"},{"label":"List container port mappings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/listclustercontainerportmappings","routeSlug":"/cluster-greater-compute/listclustercontainerportmappings","metadata":{"seo":{"title":"List container port mappings","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterContainerPortMappings","name":"List container port mappings","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1port-mapping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container port mappings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1port-mapping/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/port-mapping","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/port-mapping","href":"/cluster-greater-compute/listclustercontainerportmappings","openApiOperationId":"listClusterContainerPortMappings","summary":"List container port mappings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276"}},"schemaId":"schema_276"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1port-mapping/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_276","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/listclustercontainerportmappings"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/port-mapping"},{"label":"List container variables","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/listclustercontainervariables","routeSlug":"/cluster-greater-compute/listclustercontainervariables","metadata":{"seo":{"title":"List container variables","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterContainerVariables","name":"List container variables","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1variable/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container variables","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1variable/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/variable","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/variable","href":"/cluster-greater-compute/listclustercontainervariables","openApiOperationId":"listClusterContainerVariables","summary":"List container variables"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277"}},"schemaId":"schema_277"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1variable/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_277","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/listclustercontainervariables"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/variable"},{"label":"List container virtual networks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/listclustercontainervirtualnetworks","routeSlug":"/cluster-greater-compute/listclustercontainervirtualnetworks","metadata":{"seo":{"title":"List container virtual networks","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterContainerVirtualNetworks","name":"List container virtual networks","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1virtual-network/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container virtual networks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1virtual-network/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/virtual-network","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/virtual-network","href":"/cluster-greater-compute/listclustercontainervirtualnetworks","openApiOperationId":"listClusterContainerVirtualNetworks","summary":"List container virtual networks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278"}},"schemaId":"schema_278"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1virtual-network/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_278","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/listclustercontainervirtualnetworks"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/virtual-network"},{"label":"List container volumes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/listclustercontainervolumes","routeSlug":"/cluster-greater-compute/listclustercontainervolumes","metadata":{"seo":{"title":"List container volumes","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterContainerVolumes","name":"List container volumes","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1volume/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container volumes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1volume/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/volume","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/volume","href":"/cluster-greater-compute/listclustercontainervolumes","openApiOperationId":"listClusterContainerVolumes","summary":"List container volumes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}},"schemaId":"schema_279"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1volume/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_279","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/listclustercontainervolumes"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/volume"},{"label":"Get container VRF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/getclustercontainervrf","routeSlug":"/cluster-greater-compute/getclustercontainervrf","metadata":{"seo":{"title":"Get container VRF","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getClusterContainerVrf","name":"Get container VRF","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1vrf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get container VRF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1vrf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/vrf","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/vrf","href":"/cluster-greater-compute/getclustercontainervrf","openApiOperationId":"getClusterContainerVrf","summary":"Get container VRF"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerVRF"}},"schemaId":"components/schemas/ContainerVRF"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1container~1{containerID}~1vrf/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerVRF","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerVRF"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/getclustercontainervrf"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/vrf"},{"label":"List volumes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/listclustervolumes","routeSlug":"/cluster-greater-compute/listclustervolumes","metadata":{"seo":{"title":"List volumes","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listClusterVolumes","name":"List volumes","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List volumes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/cluster/{clusterFQDN}/exec/volume","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/volume","href":"/cluster-greater-compute/listclustervolumes","openApiOperationId":"listClusterVolumes","summary":"List volumes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}},"schemaId":"schema_279"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_279","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/listclustervolumes"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/volume"},{"label":"Create volume","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume/post","routeSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume/post","metadata":{"seo":{"title":"Create volume","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create volume","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create volume","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Volume"}},"schemaId":"components/schemas/Volume","pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume/post/requestBody","description":"Volume"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/cluster/{clusterFQDN}/exec/volume","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Volume"}},"responseCodes":["200","422"],"pointer":"/v2/cluster/{clusterFQDN}/exec/volume","href":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume/post","summary":"Create volume"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Volume","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Volume"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume/post"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/volume"},{"label":"Delete a volume","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume~1{volumename}/delete","routeSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume~1{volumename}/delete","metadata":{"seo":{"title":"Delete a volume","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a volume","isWebhook":false,"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume~1{volumeName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a volume","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"volumeName","in":"path","schemaId":"schema_240","description":"Volume Name","required":true},{"name":"clusterFQDN","in":"path","schemaId":"schema_240","description":"Node FQDN","required":true}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume~1{volumeName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/cluster/{clusterFQDN}/exec/volume/{volumeName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"volumeName","in":"path","required":true,"schemaId":"schema_240"},{"name":"clusterFQDN","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/cluster/{clusterFQDN}/exec/volume/{volumeName}","href":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume~1{volumename}/delete","summary":"Delete a volume"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1cluster~1{clusterFQDN}~1exec~1volume~1{volumeName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume~1{volumename}/delete"}],"panels":[]}]},"httpPath":"/v2/cluster/{clusterFQDN}/exec/volume/{volumeName}"}],"content":{"contentType":"group","meta":{"name":"Cluster > Compute"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compute","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/nodes/appliances/containers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cluster edge compute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Docker container workloads deployed across cluster nodes. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exec"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature flag."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/cluster/{clusterFQDN}/exec/container","summary":"Retrieve all edge computing containers running on a cluster","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/listclustercontainers","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container","summary":"Deploy a new containerized application to run on the cluster","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}","summary":"Remove a containerized application from the cluster and stop execution","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/delete","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}","summary":"Get edge compute container configuration on a cluster","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/getclustercontainer","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}","summary":"Update a container","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/capability","summary":"Retrieve security capabilities and permissions for a container","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/getclustercontainercapabilities","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/config","summary":"Update container config","prefix":{"name":"put","color":"put"},"badges":[],"link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1container~1{containerid}~1config/put","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/healthcheck","summary":"Get container health check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/getclustercontainerhealthcheck","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/interface","summary":"List container interfaces","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/listclustercontainerinterfaces","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/limit","summary":"List container limits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/listclustercontainerlimits","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/logging","summary":"Get container logging configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/getclustercontainerlogging","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/mount","summary":"List container mounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/listclustercontainermounts","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/port-mapping","summary":"List container port mappings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/listclustercontainerportmappings","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/variable","summary":"List container variables","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/listclustercontainervariables","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/virtual-network","summary":"List container virtual networks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/listclustercontainervirtualnetworks","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/volume","summary":"List container volumes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/listclustercontainervolumes","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/container/{containerID}/vrf","summary":"Get container VRF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/getclustercontainervrf","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/volume","summary":"List volumes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/cluster-greater-compute/listclustervolumes","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/volume","summary":"Create volume","prefix":{"name":"post","color":"post"},"badges":[],"link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume/post","deprecated":false},{"title":"/v2/cluster/{clusterFQDN}/exec/volume/{volumeName}","summary":"Delete a volume","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/cluster-greater-compute/paths/~1v2~1cluster~1{clusterfqdn}~1exec~1volume~1{volumename}/delete","deprecated":false}]}]}]}]}},{"type":"separator","label":"Appliance","content":null},{"type":"group","label":"Appliance","link":"/appliance","routeSlug":"/appliance","items":[{"label":"Retrieve all network nodes including appliances and agents with filtering options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/listnodes","routeSlug":"/appliance/listnodes","metadata":{"seo":{"title":"Retrieve all network nodes including appliances and agents with filtering options","description":"List both appliances and agents. The fields config and shadow will be empty unlessspecified in the projection parameter. The query for the config or shadow must be at leastone level deep - projection[0][0]=config won't work, but projection[0][0]=config&projection[0][1]=gatewaywill result in config.gateway being populated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodes","name":"Retrieve all network nodes including appliances and agents with filtering options","isWebhook":false,"pointer":"/paths/~1node/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all network nodes including appliances and agents with filtering options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List both appliances and agents. The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shadow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be empty unless"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. The query for the config or shadow must be at least"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one level deep - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[0][0]=config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" won't work, but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[0][0]=config&projection[0][1]=gateway"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will result in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.gateway"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being populated."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cluster","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided, limit the nodes to members of the cluster. Should be the full cluster FQDN, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mycluster.trustgrid.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated key:value pairs for tag filtering, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location:Austin,device:Trustgrid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"projection[]","in":"query","schemaId":"schema_280","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reduces the response to a smaller set of fields. When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"omitted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields are returned ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fqdn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cluster"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_connect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"heartbeat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lifecycleState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnectTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", plus base fields)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response contains only a fixed base set plus each explicitly requested field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base set"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (always present when any projection is specified): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgTags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Top-level requestable fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fqdn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cluster"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_connect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"heartbeat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lifecycleState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnectTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderID"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shadow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be used as flat projection keys (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[]=shadow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[]=config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are rejected as too large). To retrieve data from these objects, you must use nested indexed projection (see below)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Dot-notation strings do NOT work. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[]=config.gateway.enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" silently returns an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config: {}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. Do not use dot notation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested projection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses indexed bracket notation where each projection entry has an outer index N and each path segment has an inner index M. To request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.gateway.enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as entry 0 and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shadow.reported[\"node-core.version\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as entry 1:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[0][0]=config&projection[0][1]=gateway&projection[0][2]=enabled&projection[1][0]=shadow&projection[1][1]=reported&projection[1][2]=node-core.version"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If using curl, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-g"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag to prevent brace expansion."},"children":[]}]}]}]}],"pointer":"/paths/~1node/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/node","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"cluster","in":"query","schemaId":"schema_240"},{"name":"tags","in":"query","schemaId":"schema_240"},{"name":"projection[]","in":"query","schemaId":"schema_280","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node","href":"/appliance/listnodes","openApiOperationId":"listNodes","summary":"Retrieve all network nodes including appliances and agents with filtering options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281"}},"schemaId":"schema_281"}],"pointer":"/paths/~1node/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_281","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/listnodes"}],"panels":[]}]},"httpPath":"/node"},{"label":"Generate a license key for registering a new node to the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/getnodelicense","routeSlug":"/appliance/getnodelicense","metadata":{"seo":{"title":"Generate a license key for registering a new node to the organization","description":"Generates a license key that an appliance node uses to register with the organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeLicense","name":"Generate a license key for registering a new node to the organization","isWebhook":false,"pointer":"/paths/~1node~1license/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a license key for registering a new node to the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a license key that an appliance node uses to register with the organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_240","description":"node name","required":true}],"pointer":"/paths/~1node~1license/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/node/license","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"name","in":"query","required":true,"schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/node/license","href":"/appliance/getnodelicense","openApiOperationId":"getNodeLicense","summary":"Generate a license key for registering a new node to the organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"License body","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_240"}},"schemaId":"schema_240"},{"code":"422","description":"Validation error","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1node~1license/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_240","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_240"}}},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/getnodelicense"}],"panels":[]}]},"httpPath":"/node/license"},{"label":"Retrieve a node by its fully-qualified domain name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/getnodebyfqdn","routeSlug":"/appliance/getnodebyfqdn","metadata":{"seo":{"title":"Retrieve a node by its fully-qualified domain name","description":"Get a node using its FQDN directly, as an alternative to looking up the nodeID first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeByFQDN","name":"Retrieve a node by its fully-qualified domain name","isWebhook":false,"pointer":"/paths/~1node~1by-fqdn~1{fqdn}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a node by its fully-qualified domain name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a node using its FQDN directly, as an alternative to looking up the nodeID first."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission on the node."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fqdn","in":"path","schemaId":"schema_240","description":"Node FQDN (e.g., appliance.example.trustgrid.io)","required":true}],"pointer":"/paths/~1node~1by-fqdn~1{fqdn}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/node/by-fqdn/{fqdn}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"fqdn","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/node/by-fqdn/{fqdn}","href":"/appliance/getnodebyfqdn","openApiOperationId":"getNodeByFQDN","summary":"Retrieve a node by its fully-qualified domain name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Node"}},"schemaId":"components/schemas/Node"},{"code":"404","description":"Node not found or permission denied"}],"pointer":"/paths/~1node~1by-fqdn~1{fqdn}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Node","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Node"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/getnodebyfqdn"}],"panels":[]}]},"httpPath":"/node/by-fqdn/{fqdn}"},{"label":"Permanently remove a node from the organization and revoke access","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}/delete","routeSlug":"/appliance/paths/~1node~1{nodeid}/delete","metadata":{"seo":{"title":"Permanently remove a node from the organization and revoke access","description":"Delete a node (appliance or agent)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Permanently remove a node from the organization and revoke access","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permanently remove a node from the organization and revoke access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a node (appliance or agent)"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/node/{nodeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/node/{nodeID}","href":"/appliance/paths/~1node~1{nodeid}/delete","summary":"Permanently remove a node from the organization and revoke access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1node~1{nodeID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}/delete"}],"panels":[]}]},"httpPath":"/node/{nodeID}"},{"label":"Retrieve detailed configuration and status information for a specific node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/getnode","routeSlug":"/appliance/getnode","metadata":{"seo":{"title":"Retrieve detailed configuration and status information for a specific node","description":"Get a node (appliance or agent)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNode","name":"Retrieve detailed configuration and status information for a specific node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed configuration and status information for a specific node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a node (appliance or agent)"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/node/{nodeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/node/{nodeID}","href":"/appliance/getnode","openApiOperationId":"getNode","summary":"Retrieve detailed configuration and status information for a specific node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Node"}},"schemaId":"components/schemas/Node"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1node~1{nodeID}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Node","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Node"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/getnode"}],"panels":[]}]},"httpPath":"/node/{nodeID}"},{"label":"Modify node settings including cluster assignment and operational state","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}/put","routeSlug":"/appliance/paths/~1node~1{nodeid}/put","metadata":{"seo":{"title":"Modify node settings including cluster assignment and operational state","description":"Update a node (appliance or agent)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify node settings including cluster assignment and operational state","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify node settings including cluster assignment and operational state","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a node (appliance or agent)"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_282"}},"schemaId":"schema_282","pointer":"/paths/~1node~1{nodeID}/put/requestBody","description":"Node updates"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_282"}},"responseCodes":["200"],"pointer":"/node/{nodeID}","href":"/appliance/paths/~1node~1{nodeid}/put","summary":"Modify node settings including cluster assignment and operational state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_282","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_282"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}"},{"label":"Configure alert thresholds and notification settings for a specific appliance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1config~1alert/put","routeSlug":"/appliance/paths/~1node~1{nodeid}~1config~1alert/put","metadata":{"seo":{"title":"Configure alert thresholds and notification settings for a specific appliance","description":"Applicable to appliances only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure alert thresholds and notification settings for a specific appliance","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1alert/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure alert thresholds and notification settings for a specific appliance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Applicable to appliances only.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1alert/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_283"}},"schemaId":"schema_283","pointer":"/paths/~1node~1{nodeID}~1config~1alert/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/alert","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_283"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/config/alert","href":"/appliance/paths/~1node~1{nodeid}~1config~1alert/put","summary":"Configure alert thresholds and notification settings for a specific appliance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_283","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_283"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1alert/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1config~1alert/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/alert"},{"label":"Configure high-availability cluster settings for a specific appliance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1config~1cluster/put","routeSlug":"/appliance/paths/~1node~1{nodeid}~1config~1cluster/put","metadata":{"seo":{"title":"Configure high-availability cluster settings for a specific appliance","description":"Applicable to appliances only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure high-availability cluster settings for a specific appliance","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1cluster/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure high-availability cluster settings for a specific appliance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Applicable to appliances only.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1cluster/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_284"}},"schemaId":"schema_284","pointer":"/paths/~1node~1{nodeID}~1config~1cluster/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/cluster","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_284"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/config/cluster","href":"/appliance/paths/~1node~1{nodeid}~1config~1cluster/put","summary":"Configure high-availability cluster settings for a specific appliance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_284","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_284"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1cluster/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1config~1cluster/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/cluster"},{"label":"Configure inbound network connectors for external access to node services","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/put","routeSlug":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/put","metadata":{"seo":{"title":"Configure inbound network connectors for external access to node services","description":"Configure inbound network connectors for external access to node services"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure inbound network connectors for external access to node services","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure inbound network connectors for external access to node services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectorConfig"}},"schemaId":"components/schemas/ConnectorConfig","pointer":"/paths/~1node~1{nodeID}~1config~1connectors/put/requestBody","description":"Config body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/connectors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectorConfig"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/config/connectors","href":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/put","summary":"Configure inbound network connectors for external access to node services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ConnectorConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectorConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/connectors"},{"label":"Remove all connector configurations from a node","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/delete","routeSlug":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/delete","metadata":{"seo":{"title":"Remove all connector configurations from a node","description":"Remove all connector configurations from a node"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove all connector configurations from a node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove all connector configurations from a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/node/{nodeID}/config/connectors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node/{nodeID}/config/connectors","href":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/delete","summary":"Remove all connector configurations from a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/delete"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/connectors"},{"label":"Create a new inbound connector to expose services running on the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors/post","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors/post","metadata":{"seo":{"title":"Create a new inbound connector to expose services running on the node","description":"Requires node::configure::connectors permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new inbound connector to expose services running on the node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new inbound connector to expose services running on the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"schemaId":"components/schemas/EdgeConnector","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors/post/requestBody","description":"Connector"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/connectors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/connectors","href":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors/post","summary":"Create a new inbound connector to expose services running on the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeConnector","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/connectors"},{"label":"Migrate a node's connector configuration to the latest V2 format","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post","metadata":{"seo":{"title":"Migrate a node's connector configuration to the latest V2 format","description":"Requires node::configure::connectors permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Migrate a node's connector configuration to the latest V2 format","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1upgrade/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate a node's connector configuration to the latest V2 format","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1upgrade/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/connectors/upgrade","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/connectors/upgrade","href":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post","summary":"Migrate a node's connector configuration to the latest V2 format"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1upgrade/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/connectors/upgrade"},{"label":"Modify settings for an existing connector on a node","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put","metadata":{"seo":{"title":"Modify settings for an existing connector on a node","description":"Applies to appliances and agents. Requires V2 connector config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify settings for an existing connector on a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify settings for an existing connector on a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies to appliances and agents. Requires V2 connector config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"connectorID","in":"path","schemaId":"schema_240","description":"Connector ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"schemaId":"components/schemas/EdgeConnector","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/put/requestBody","description":"Connector"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/connectors/{connectorID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"connectorID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/connectors/{connectorID}","href":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put","summary":"Modify settings for an existing connector on a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeConnector","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/connectors/{connectorID}"},{"label":"Remove a specific connector configuration from a node","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete","metadata":{"seo":{"title":"Remove a specific connector configuration from a node","description":"Delete a connector from a node (appliance or agent). Requires V2 connector config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a specific connector configuration from a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a specific connector configuration from a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a connector from a node (appliance or agent). Requires V2 connector config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"connectorID","in":"path","schemaId":"schema_240","description":"Connector ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/connectors/{connectorID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"connectorID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/connectors/{connectorID}","href":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete","summary":"Remove a specific connector configuration from a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/connectors/{connectorID}"},{"label":"Configure network interfaces, routing, and firewall rules for an appliance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1config~1network/put","routeSlug":"/appliance/paths/~1node~1{nodeid}~1config~1network/put","metadata":{"seo":{"title":"Configure network interfaces, routing, and firewall rules for an appliance","description":"Update network configuration for a node (appliance)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure network interfaces, routing, and firewall rules for an appliance","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1network/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure network interfaces, routing, and firewall rules for an appliance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update network configuration for a node (appliance)"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1network/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_268"}},"schemaId":"schema_268","pointer":"/paths/~1node~1{nodeID}~1config~1network/put/requestBody","description":"Network Config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/network","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_268"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/config/network","href":"/appliance/paths/~1node~1{nodeid}~1config~1network/put","summary":"Configure network interfaces, routing, and firewall rules for an appliance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_268","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_268"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1network/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1config~1network/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/network"},{"label":"Configure the BGP routing plugin on an appliance","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/updatenodebgpconfig","routeSlug":"/appliance/updatenodebgpconfig","metadata":{"seo":{"title":"Configure the BGP routing plugin on an appliance","description":"Update the base BGP settings stored in config._bgp for a node. Thisendpoint only updates the top-level BGP fields: enabled, id, asn,and client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNodeBGPConfig","name":"Configure the BGP routing plugin on an appliance","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure the BGP routing plugin on an appliance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the base BGP settings stored in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config._bgp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a node. This"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"endpoint only updates the top-level BGP fields: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the peer-group and policy endpoints under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/node/{nodeID}/config/network/bgp/..."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to manage nested BGP objects without replacing the full structure."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read the current BGP config from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /node/{nodeID}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPConfigUpdate"}},"schemaId":"components/schemas/BGPConfigUpdate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp/put/requestBody","description":"BGP top-level update request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/network/bgp","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPConfigUpdate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp","href":"/appliance/updatenodebgpconfig","openApiOperationId":"updateNodeBGPConfig","summary":"Configure the BGP routing plugin on an appliance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPConfigUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPConfigUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/updatenodebgpconfig"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp"},{"label":"Create a BGP peer group on a node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/createnodebgppeergroup","routeSlug":"/appliance/createnodebgppeergroup","metadata":{"seo":{"title":"Create a BGP peer group on a node","description":"Add a peer group to config._bgp.groups for the specified node."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNodeBGPPeerGroup","name":"Create a BGP peer group on a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a BGP peer group on a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a peer group to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config._bgp.groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the specified node."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Peer group names must be unique within the node's BGP configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPPeerGroupCreate"}},"schemaId":"components/schemas/BGPPeerGroupCreate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-groups/post/requestBody","description":"BGP peer group create request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/network/bgp/peer-groups","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPPeerGroupCreate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-groups","href":"/appliance/createnodebgppeergroup","openApiOperationId":"createNodeBGPPeerGroup","summary":"Create a BGP peer group on a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPPeerGroupCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPPeerGroupCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-groups/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/createnodebgppeergroup"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-groups"},{"label":"Delete a BGP peer group from a node","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/deletenodebgppeergroup","routeSlug":"/appliance/deletenodebgppeergroup","metadata":{"seo":{"title":"Delete a BGP peer group from a node","description":"Remove a peer group and all peers and policies nested under it from thenode's BGP configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNodeBGPPeerGroup","name":"Delete a BGP peer group from a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a BGP peer group from a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a peer group and all peers and policies nested under it from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"node's BGP configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}","href":"/appliance/deletenodebgppeergroup","openApiOperationId":"deleteNodeBGPPeerGroup","summary":"Delete a BGP peer group from a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/deletenodebgppeergroup"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}"},{"label":"Create a BGP peer in a peer group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/createnodebgppeer","routeSlug":"/appliance/createnodebgppeer","metadata":{"seo":{"title":"Create a BGP peer in a peer group","description":"Add a remote BGP peer to the specified peer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNodeBGPPeer","name":"Create a BGP peer in a peer group","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a BGP peer in a peer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a remote BGP peer to the specified peer group."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPPeerCreate"}},"schemaId":"components/schemas/BGPPeerCreate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peers/post/requestBody","description":"BGP peer create request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peers","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPPeerCreate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peers","href":"/appliance/createnodebgppeer","openApiOperationId":"createNodeBGPPeer","summary":"Create a BGP peer in a peer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPPeerCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPPeerCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/createnodebgppeer"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peers"},{"label":"Update a BGP peer in a peer group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/updatenodebgppeer","routeSlug":"/appliance/updatenodebgppeer","metadata":{"seo":{"title":"Update a BGP peer in a peer group","description":"Update a remote BGP peer in the specified peer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNodeBGPPeer","name":"Update a BGP peer in a peer group","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peers~1{peerId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a BGP peer in a peer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a remote BGP peer in the specified peer group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"secret"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted, the existing secret is preserved."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"peerId","in":"path","schemaId":"schema_240","description":"BGP peer ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peers~1{peerId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPPeerUpdate"}},"schemaId":"components/schemas/BGPPeerUpdate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peers~1{peerId}/put/requestBody","description":"BGP peer update request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peers/{peerId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPPeerUpdate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peers/{peerId}","href":"/appliance/updatenodebgppeer","openApiOperationId":"updateNodeBGPPeer","summary":"Update a BGP peer in a peer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPPeerUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPPeerUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peers~1{peerId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/updatenodebgppeer"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peers/{peerId}"},{"label":"Delete a BGP peer from a peer group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/deletenodebgppeer","routeSlug":"/appliance/deletenodebgppeer","metadata":{"seo":{"title":"Delete a BGP peer from a peer group","description":"Remove a remote BGP peer from the specified peer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNodeBGPPeer","name":"Delete a BGP peer from a peer group","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peer~1{peerId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a BGP peer from a peer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a remote BGP peer from the specified peer group."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"peerId","in":"path","schemaId":"schema_240","description":"BGP peer ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peer~1{peerId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peer/{peerId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peer/{peerId}","href":"/appliance/deletenodebgppeer","openApiOperationId":"deleteNodeBGPPeer","summary":"Delete a BGP peer from a peer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1peer~1{peerId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/deletenodebgppeer"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peer/{peerId}"},{"label":"Create an import policy in a BGP peer group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/createnodebgpimportpolicy","routeSlug":"/appliance/createnodebgpimportpolicy","metadata":{"seo":{"title":"Create an import policy in a BGP peer group","description":"Add an import policy to the specified peer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNodeBGPImportPolicy","name":"Create an import policy in a BGP peer group","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an import policy in a BGP peer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add an import policy to the specified peer group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New import policies start with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match.prefixes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPImportPolicyCreate"}},"schemaId":"components/schemas/BGPImportPolicyCreate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policies/post/requestBody","description":"BGP import policy create request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policies","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPImportPolicyCreate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policies","href":"/appliance/createnodebgpimportpolicy","openApiOperationId":"createNodeBGPImportPolicy","summary":"Create an import policy in a BGP peer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPImportPolicyCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPImportPolicyCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/createnodebgpimportpolicy"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policies"},{"label":"Update an import policy in a BGP peer group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/updatenodebgpimportpolicy","routeSlug":"/appliance/updatenodebgpimportpolicy","metadata":{"seo":{"title":"Update an import policy in a BGP peer group","description":"Update an import policy in the specified peer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNodeBGPImportPolicy","name":"Update an import policy in a BGP peer group","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policies~1{policyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an import policy in a BGP peer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an import policy in the specified peer group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating the policy preserves the existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match.prefixes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entries."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"policyId","in":"path","schemaId":"schema_240","description":"BGP policy ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policies~1{policyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPImportPolicyUpdate"}},"schemaId":"components/schemas/BGPImportPolicyUpdate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policies~1{policyId}/put/requestBody","description":"BGP import policy update request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policies/{policyId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"policyId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPImportPolicyUpdate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policies/{policyId}","href":"/appliance/updatenodebgpimportpolicy","openApiOperationId":"updateNodeBGPImportPolicy","summary":"Update an import policy in a BGP peer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPImportPolicyUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPImportPolicyUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policies~1{policyId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/updatenodebgpimportpolicy"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policies/{policyId}"},{"label":"Delete an import policy from a BGP peer group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/deletenodebgpimportpolicy","routeSlug":"/appliance/deletenodebgpimportpolicy","metadata":{"seo":{"title":"Delete an import policy from a BGP peer group","description":"Remove an import policy from the specified peer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNodeBGPImportPolicy","name":"Delete an import policy from a BGP peer group","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an import policy from a BGP peer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove an import policy from the specified peer group."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"importPolicyId","in":"path","schemaId":"schema_240","description":"BGP import policy ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"importPolicyId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}","href":"/appliance/deletenodebgpimportpolicy","openApiOperationId":"deleteNodeBGPImportPolicy","summary":"Delete an import policy from a BGP peer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/deletenodebgpimportpolicy"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}"},{"label":"Create an import policy prefix match","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/createnodebgpimportpolicyprefix","routeSlug":"/appliance/createnodebgpimportpolicyprefix","metadata":{"seo":{"title":"Create an import policy prefix match","description":"Add a prefix matcher to an import policy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNodeBGPImportPolicyPrefix","name":"Create an import policy prefix match","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefixes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an import policy prefix match","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add a prefix matcher to an import policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"importPolicyId","in":"path","schemaId":"schema_240","description":"BGP import policy ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefixes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPImportPrefixCreate"}},"schemaId":"components/schemas/BGPImportPrefixCreate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefixes/post/requestBody","description":"BGP import prefix create request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefixes","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"importPolicyId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPImportPrefixCreate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefixes","href":"/appliance/createnodebgpimportpolicyprefix","openApiOperationId":"createNodeBGPImportPolicyPrefix","summary":"Create an import policy prefix match"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPImportPrefixCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPImportPrefixCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefixes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/createnodebgpimportpolicyprefix"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefixes"},{"label":"Update an import policy prefix match","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/updatenodebgpimportpolicyprefix","routeSlug":"/appliance/updatenodebgpimportpolicyprefix","metadata":{"seo":{"title":"Update an import policy prefix match","description":"Update a prefix matcher in an import policy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNodeBGPImportPolicyPrefix","name":"Update an import policy prefix match","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefixes~1{prefixId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an import policy prefix match","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a prefix matcher in an import policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"importPolicyId","in":"path","schemaId":"schema_240","description":"BGP import policy ID","required":true},{"name":"prefixId","in":"path","schemaId":"schema_240","description":"BGP prefix entry ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefixes~1{prefixId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPImportPrefixUpdate"}},"schemaId":"components/schemas/BGPImportPrefixUpdate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefixes~1{prefixId}/put/requestBody","description":"BGP import prefix update request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefixes/{prefixId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"importPolicyId","in":"path","required":true,"schemaId":"schema_240"},{"name":"prefixId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPImportPrefixUpdate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefixes/{prefixId}","href":"/appliance/updatenodebgpimportpolicyprefix","openApiOperationId":"updateNodeBGPImportPolicyPrefix","summary":"Update an import policy prefix match"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPImportPrefixUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPImportPrefixUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefixes~1{prefixId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/updatenodebgpimportpolicyprefix"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefixes/{prefixId}"},{"label":"Delete an import policy prefix match","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/deletenodebgpimportpolicyprefix","routeSlug":"/appliance/deletenodebgpimportpolicyprefix","metadata":{"seo":{"title":"Delete an import policy prefix match","description":"Remove a prefix matcher from an import policy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNodeBGPImportPolicyPrefix","name":"Delete an import policy prefix match","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefix~1{prefixId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an import policy prefix match","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove a prefix matcher from an import policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"importPolicyId","in":"path","schemaId":"schema_240","description":"BGP import policy ID","required":true},{"name":"prefixId","in":"path","schemaId":"schema_240","description":"BGP prefix entry ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefix~1{prefixId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefix/{prefixId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"importPolicyId","in":"path","required":true,"schemaId":"schema_240"},{"name":"prefixId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefix/{prefixId}","href":"/appliance/deletenodebgpimportpolicyprefix","openApiOperationId":"deleteNodeBGPImportPolicyPrefix","summary":"Delete an import policy prefix match"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1import-policy~1{importPolicyId}~1match~1prefix~1{prefixId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/deletenodebgpimportpolicyprefix"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefix/{prefixId}"},{"label":"Create an export policy in a BGP peer group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/createnodebgpexportpolicy","routeSlug":"/appliance/createnodebgpexportpolicy","metadata":{"seo":{"title":"Create an export policy in a BGP peer group","description":"Add an export policy to the specified peer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNodeBGPExportPolicy","name":"Create an export policy in a BGP peer group","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policies/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an export policy in a BGP peer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add an export policy to the specified peer group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"New export policies always start with an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action.prefixes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policies/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPExportPolicyCreate"}},"schemaId":"components/schemas/BGPExportPolicyCreate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policies/post/requestBody","description":"BGP export policy create request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policies","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPExportPolicyCreate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policies","href":"/appliance/createnodebgpexportpolicy","openApiOperationId":"createNodeBGPExportPolicy","summary":"Create an export policy in a BGP peer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPExportPolicyCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPExportPolicyCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policies/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/createnodebgpexportpolicy"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policies"},{"label":"Update an export policy in a BGP peer group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/updatenodebgpexportpolicy","routeSlug":"/appliance/updatenodebgpexportpolicy","metadata":{"seo":{"title":"Update an export policy in a BGP peer group","description":"Update an export policy in the specified peer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNodeBGPExportPolicy","name":"Update an export policy in a BGP peer group","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policies~1{policyId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an export policy in a BGP peer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an export policy in the specified peer group."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updating the policy preserves the existing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action.prefixes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" entries."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"policyId","in":"path","schemaId":"schema_240","description":"BGP policy ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policies~1{policyId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPExportPolicyUpdate"}},"schemaId":"components/schemas/BGPExportPolicyUpdate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policies~1{policyId}/put/requestBody","description":"BGP export policy update request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policies/{policyId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"policyId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPExportPolicyUpdate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policies/{policyId}","href":"/appliance/updatenodebgpexportpolicy","openApiOperationId":"updateNodeBGPExportPolicy","summary":"Update an export policy in a BGP peer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPExportPolicyUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPExportPolicyUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policies~1{policyId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/updatenodebgpexportpolicy"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policies/{policyId}"},{"label":"Delete an export policy from a BGP peer group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/deletenodebgpexportpolicy","routeSlug":"/appliance/deletenodebgpexportpolicy","metadata":{"seo":{"title":"Delete an export policy from a BGP peer group","description":"Remove an export policy from the specified peer group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNodeBGPExportPolicy","name":"Delete an export policy from a BGP peer group","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an export policy from a BGP peer group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove an export policy from the specified peer group."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"exportPolicyId","in":"path","schemaId":"schema_240","description":"BGP export policy ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"exportPolicyId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}","href":"/appliance/deletenodebgpexportpolicy","openApiOperationId":"deleteNodeBGPExportPolicy","summary":"Delete an export policy from a BGP peer group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/deletenodebgpexportpolicy"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}"},{"label":"Create an export policy prefix","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/createnodebgpexportpolicyprefix","routeSlug":"/appliance/createnodebgpexportpolicyprefix","metadata":{"seo":{"title":"Create an export policy prefix","description":"Add an exported prefix entry to an export policy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createNodeBGPExportPolicyPrefix","name":"Create an export policy prefix","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefixes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an export policy prefix","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add an exported prefix entry to an export policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"exportPolicyId","in":"path","schemaId":"schema_240","description":"BGP export policy ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefixes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPExportPrefixCreate"}},"schemaId":"components/schemas/BGPExportPrefixCreate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefixes/post/requestBody","description":"BGP export prefix create request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefixes","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"exportPolicyId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPExportPrefixCreate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefixes","href":"/appliance/createnodebgpexportpolicyprefix","openApiOperationId":"createNodeBGPExportPolicyPrefix","summary":"Create an export policy prefix"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPExportPrefixCreate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPExportPrefixCreate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefixes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/createnodebgpexportpolicyprefix"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefixes"},{"label":"Update an export policy prefix","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/updatenodebgpexportpolicyprefix","routeSlug":"/appliance/updatenodebgpexportpolicyprefix","metadata":{"seo":{"title":"Update an export policy prefix","description":"Update an exported prefix entry in an export policy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateNodeBGPExportPolicyPrefix","name":"Update an export policy prefix","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefixes~1{prefixId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an export policy prefix","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an exported prefix entry in an export policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"exportPolicyId","in":"path","schemaId":"schema_240","description":"BGP export policy ID","required":true},{"name":"prefixId","in":"path","schemaId":"schema_240","description":"BGP prefix entry ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefixes~1{prefixId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPExportPrefixUpdate"}},"schemaId":"components/schemas/BGPExportPrefixUpdate","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefixes~1{prefixId}/put/requestBody","description":"BGP export prefix update request"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefixes/{prefixId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"exportPolicyId","in":"path","required":true,"schemaId":"schema_240"},{"name":"prefixId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/BGPExportPrefixUpdate"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefixes/{prefixId}","href":"/appliance/updatenodebgpexportpolicyprefix","openApiOperationId":"updateNodeBGPExportPolicyPrefix","summary":"Update an export policy prefix"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/BGPExportPrefixUpdate","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/BGPExportPrefixUpdate"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefixes~1{prefixId}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/updatenodebgpexportpolicyprefix"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefixes/{prefixId}"},{"label":"Delete an export policy prefix","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/deletenodebgpexportpolicyprefix","routeSlug":"/appliance/deletenodebgpexportpolicyprefix","metadata":{"seo":{"title":"Delete an export policy prefix","description":"Remove an exported prefix entry from an export policy."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteNodeBGPExportPolicyPrefix","name":"Delete an export policy prefix","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefix~1{prefixId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an export policy prefix","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Remove an exported prefix entry from an export policy."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"peerGroupId","in":"path","schemaId":"schema_240","description":"BGP peer group ID","required":true},{"name":"exportPolicyId","in":"path","schemaId":"schema_240","description":"BGP export policy ID","required":true},{"name":"prefixId","in":"path","schemaId":"schema_240","description":"BGP prefix entry ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefix~1{prefixId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefix/{prefixId}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"peerGroupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"exportPolicyId","in":"path","required":true,"schemaId":"schema_240"},{"name":"prefixId","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefix/{prefixId}","href":"/appliance/deletenodebgpexportpolicyprefix","openApiOperationId":"deleteNodeBGPExportPolicyPrefix","summary":"Delete an export policy prefix"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1network~1bgp~1peer-group~1{peerGroupId}~1export-policy~1{exportPolicyId}~1match~1prefix~1{prefixId}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/deletenodebgpexportpolicyprefix"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefix/{prefixId}"},{"label":"Configure outbound services for external connections from the node","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1config~1services/put","routeSlug":"/appliance/paths/~1node~1{nodeid}~1config~1services/put","metadata":{"seo":{"title":"Configure outbound services for external connections from the node","description":"Update services configuration for a node (appliance or agent)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure outbound services for external connections from the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1services/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure outbound services for external connections from the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update services configuration for a node (appliance or agent)\n\n---\n\nNote: request body will be validated by JSON schema of the plugin\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1services/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceConfig"}},"schemaId":"components/schemas/ServiceConfig","pointer":"/paths/~1node~1{nodeID}~1config~1services/put/requestBody","description":"Config body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/services","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceConfig"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/config/services","href":"/appliance/paths/~1node~1{nodeid}~1config~1services/put","summary":"Configure outbound services for external connections from the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ServiceConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1services/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1config~1services/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/services"},{"label":"Create a new outbound service connection for external resource access","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services/post","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services/post","metadata":{"seo":{"title":"Create a new outbound service connection for external resource access","description":"Requires node::configure::services permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new outbound service connection for external resource access","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new outbound service connection for external resource access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"schemaId":"components/schemas/EdgeService","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services/post/requestBody","description":"Service"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/services","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/services","href":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services/post","summary":"Create a new outbound service connection for external resource access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeService","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/services"},{"label":"Migrate a node's service configuration to the latest V2 format","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post","metadata":{"seo":{"title":"Migrate a node's service configuration to the latest V2 format","description":"Requires node::configure::services permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Migrate a node's service configuration to the latest V2 format","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1upgrade/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate a node's service configuration to the latest V2 format","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1upgrade/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/services/upgrade","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/services/upgrade","href":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post","summary":"Migrate a node's service configuration to the latest V2 format"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1upgrade/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/services/upgrade"},{"label":"Modify settings for an existing service connection on a node","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put","metadata":{"seo":{"title":"Modify settings for an existing service connection on a node","description":"Update a service on a node. Requires V2 services config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify settings for an existing service connection on a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify settings for an existing service connection on a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a service on a node. Requires V2 services config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"serviceID","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"schemaId":"components/schemas/EdgeService","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/put/requestBody","description":"Service"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/services/{serviceID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"serviceID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/services/{serviceID}","href":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put","summary":"Modify settings for an existing service connection on a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeService","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/services/{serviceID}"},{"label":"Remove a specific service configuration from a node","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete","metadata":{"seo":{"title":"Remove a specific service configuration from a node","description":"Delete a service from a node. Requires V2 services config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a specific service configuration from a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a specific service configuration from a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a service from a node. Requires V2 services config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"serviceID","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/services/{serviceID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"serviceID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/services/{serviceID}","href":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete","summary":"Remove a specific service configuration from a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/services/{serviceID}"},{"label":"Configure Zero Trust Network Access gateway settings for secure remote access","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/put","routeSlug":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/put","metadata":{"seo":{"title":"Configure Zero Trust Network Access gateway settings for secure remote access","description":"Update APIGW gateway configuration for a node (appliance)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure Zero Trust Network Access gateway settings for secure remote access","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1ztnagw/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure Zero Trust Network Access gateway settings for secure remote access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update APIGW gateway configuration for a node (appliance)"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note that this endpoint used to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apigw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The config section is still named "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apigw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"WireGuard\" is a registered trademark of Jason A. Donenfeld."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::apigw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1ztnagw/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285"}},"schemaId":"schema_285","pointer":"/paths/~1node~1{nodeID}~1config~1ztnagw/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/ztnagw","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_285"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/config/ztnagw","href":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/put","summary":"Configure Zero Trust Network Access gateway settings for secure remote access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_285","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_285"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1ztnagw/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/ztnagw"},{"label":"Remove APIGW gateway configuration and disable secure remote access","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/delete","routeSlug":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/delete","metadata":{"seo":{"title":"Remove APIGW gateway configuration and disable secure remote access","description":"Delete the APIGW gateway configuration for a node (appliance)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove APIGW gateway configuration and disable secure remote access","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1ztnagw/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove APIGW gateway configuration and disable secure remote access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete the APIGW gateway configuration for a node (appliance)"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::apigw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1ztnagw/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/node/{nodeID}/config/ztnagw","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node/{nodeID}/config/ztnagw","href":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/delete","summary":"Remove APIGW gateway configuration and disable secure remote access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1ztnagw/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/delete"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/ztnagw"},{"label":"Configure node as a network gateway for routing traffic between networks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1config~1gateway/put","routeSlug":"/appliance/paths/~1node~1{nodeid}~1config~1gateway/put","metadata":{"seo":{"title":"Configure node as a network gateway for routing traffic between networks","description":"Update gateway configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure node as a network gateway for routing traffic between networks","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1gateway/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure node as a network gateway for routing traffic between networks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update gateway configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"host"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for the gateway hostname."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:gateway"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1gateway/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_286"}},"schemaId":"schema_286","pointer":"/paths/~1node~1{nodeID}~1config~1gateway/put/requestBody","description":"Gateway config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/gateway","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_286"}},"responseCodes":["200","422"],"pointer":"/node/{nodeID}/config/gateway","href":"/appliance/paths/~1node~1{nodeid}~1config~1gateway/put","summary":"Configure node as a network gateway for routing traffic between networks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_286","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_286"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1node~1{nodeID}~1config~1gateway/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1config~1gateway/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/gateway"},{"label":"Configure SNMP monitoring settings for network management integration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1snmp/put","routeSlug":"/appliance/paths/~1node~1{nodeid}~1snmp/put","metadata":{"seo":{"title":"Configure SNMP monitoring settings for network management integration","description":"Update SNMP configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure SNMP monitoring settings for network management integration","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1snmp/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure SNMP monitoring settings for network management integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update SNMP configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:snmp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1snmp/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_287"}},"schemaId":"schema_287","pointer":"/paths/~1node~1{nodeID}~1snmp/put/requestBody","description":"SNMP config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/snmp","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_287"}},"responseCodes":["200","422"],"pointer":"/node/{nodeID}/snmp","href":"/appliance/paths/~1node~1{nodeid}~1snmp/put","summary":"Configure SNMP monitoring settings for network management integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_287","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_287"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1node~1{nodeID}~1snmp/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1snmp/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/snmp"},{"label":"Remove a metadata tag from a node for organizational categorization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/delete","routeSlug":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/delete","metadata":{"seo":{"title":"Remove a metadata tag from a node for organizational categorization","description":"Remove a metadata tag from a node for organizational categorization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a metadata tag from a node for organizational categorization","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a metadata tag from a node for organizational categorization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"tagName","in":"path","schemaId":"schema_240","description":"Tag name","required":true}],"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/node/{nodeID}/tag/{tagName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"tagName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node/{nodeID}/tag/{tagName}","href":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/delete","summary":"Remove a metadata tag from a node for organizational categorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/delete"}],"panels":[]}]},"httpPath":"/node/{nodeID}/tag/{tagName}"},{"label":"Add or update a metadata tag on a node for organizational categorization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/put","routeSlug":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/put","metadata":{"seo":{"title":"Add or update a metadata tag on a node for organizational categorization","description":"Add or update a metadata tag on a node for organizational categorization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add or update a metadata tag on a node for organizational categorization","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add or update a metadata tag on a node for organizational categorization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"tagName","in":"path","schemaId":"schema_240","description":"Tag name","required":true}],"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagValueModel"}},"schemaId":"components/schemas/TagValueModel","pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/tag/{tagName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"tagName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagValueModel"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/tag/{tagName}","href":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/put","summary":"Add or update a metadata tag on a node for organizational categorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/TagValueModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagValueModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/tag/{tagName}"},{"label":"List AWS route tables attached to the node host","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodeawsroutetables","routeSlug":"/appliance/triggernodeawsroutetables","metadata":{"seo":{"title":"List AWS route tables attached to the node host","description":"Retrieves the AWS EC2 route tables associated with the node's network interfaces.Optionally filters by a specific network interface card (NIC). Available onAWS-hosted nodes only."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeAwsRouteTables","name":"List AWS route tables attached to the node host","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1aws-route-tables/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List AWS route tables attached to the node host","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the AWS EC2 route tables associated with the node's network interfaces."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally filters by a specific network interface card (NIC). Available on"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AWS-hosted nodes only."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:aws-route-tables"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1aws-route-tables/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1aws-route-tables/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_289"}},"schemaId":"schema_289","pointer":"/paths/~1node~1{nodeID}~1trigger~1aws-route-tables/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/aws-route-tables","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_289"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/aws-route-tables","href":"/appliance/triggernodeawsroutetables","openApiOperationId":"triggerNodeAwsRouteTables","summary":"List AWS route tables attached to the node host"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_289","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_289"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}},"schemaId":"schema_290"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1aws-route-tables/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_290","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_290"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodeawsroutetables"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/aws-route-tables"},{"label":"Manage the node's local datastore files","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodedatastoremanager","routeSlug":"/appliance/triggernodedatastoremanager","metadata":{"seo":{"title":"Manage the node's local datastore files","description":"List or manage files in the node's local datastore directory."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeDatastoreManager","name":"Manage the node's local datastore files","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1datastore-manager/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manage the node's local datastore files","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List or manage files in the node's local datastore directory."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:datastore-manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1datastore-manager/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1datastore-manager/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_291"}},"schemaId":"schema_291","pointer":"/paths/~1node~1{nodeID}~1trigger~1datastore-manager/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/datastore-manager","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_291"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/datastore-manager","href":"/appliance/triggernodedatastoremanager","openApiOperationId":"triggerNodeDatastoreManager","summary":"Manage the node's local datastore files"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_291","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_291"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292"}},"schemaId":"schema_292"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1datastore-manager/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_292","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodedatastoremanager"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/datastore-manager"},{"label":"View or delete active network flows on the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodeflows","routeSlug":"/appliance/triggernodeflows","metadata":{"seo":{"title":"View or delete active network flows on the node","description":"Returns the node's active network flow table, optionally filtered by protocol,source/destination IP and port, container, or virtual network. Setting actionto delete terminates matching flows instead of returning them."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeFlows","name":"View or delete active network flows on the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1flows/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"View or delete active network flows on the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the node's active network flow table, optionally filtered by protocol,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"source/destination IP and port, container, or virtual network. Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" terminates matching flows instead of returning them."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:flows"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1flows/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1flows/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_293"}},"schemaId":"schema_293","pointer":"/paths/~1node~1{nodeID}~1trigger~1flows/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/flows","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_293"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/flows","href":"/appliance/triggernodeflows","openApiOperationId":"triggerNodeFlows","summary":"View or delete active network flows on the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_293","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_293"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_294"}},"schemaId":"schema_294"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1flows/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_294","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_294"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodeflows"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/flows"},{"label":"Run a throughput performance test to a peer gateway node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodegatewayperf","routeSlug":"/appliance/triggernodegatewayperf","metadata":{"seo":{"title":"Run a throughput performance test to a peer gateway node","description":"Opens a streaming session that sends a configurable amount of data to thedestination node and measures throughput. Progress is streamed as text whilethe test runs; a summary line with rate in Mbps is emitted at the end."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeGatewayPerf","name":"Run a throughput performance test to a peer gateway node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run a throughput performance test to a peer gateway node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opens a streaming session that sends a configurable amount of data to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"destination node and measures throughput. Progress is streamed as text while"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the test runs; a summary line with rate in Mbps is emitted at the end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the test completes and receive the full output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:gateway-perf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_295"}},"schemaId":"schema_295","pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/gateway-perf","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_295"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/gateway-perf","href":"/appliance/triggernodegatewayperf","openApiOperationId":"triggerNodeGatewayPerf","summary":"Run a throughput performance test to a peer gateway node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_295","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_295"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodegatewayperf"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/gateway-perf"},{"label":"Ping a peer gateway node over the Trustgrid overlay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodegatewayping","routeSlug":"/appliance/triggernodegatewayping","metadata":{"seo":{"title":"Ping a peer gateway node over the Trustgrid overlay","description":"Sends echo packets to the specified destination node through the Trustgridgateway overlay and reports round-trip latency. Results stream as JSON objectswith RTT measurements."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeGatewayPing","name":"Ping a peer gateway node over the Trustgrid overlay","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ping a peer gateway node over the Trustgrid overlay","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends echo packets to the specified destination node through the Trustgrid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gateway overlay and reports round-trip latency. Results stream as JSON objects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with RTT measurements."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the session ends and receive buffered output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:gateway-ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_296"}},"schemaId":"schema_296","pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/gateway-ping","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_296"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/gateway-ping","href":"/appliance/triggernodegatewayping","openApiOperationId":"triggerNodeGatewayPing","summary":"Ping a peer gateway node over the Trustgrid overlay"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_296","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_296"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodegatewayping"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/gateway-ping"},{"label":"Retrieve the node's active gateway routing table","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodegatewayroutes","routeSlug":"/appliance/triggernodegatewayroutes","metadata":{"seo":{"title":"Retrieve the node's active gateway routing table","description":"Returns the gateway peer routing table showing which nodes the gateway isconnected to, their RTT, throughput, and path details."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeGatewayRoutes","name":"Retrieve the node's active gateway routing table","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-routes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the node's active gateway routing table","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the gateway peer routing table showing which nodes the gateway is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"connected to, their RTT, throughput, and path details."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:gateway-routes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-routes/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-routes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_297"}},"schemaId":"schema_297","pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-routes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/gateway-routes","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_297"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/gateway-routes","href":"/appliance/triggernodegatewayroutes","openApiOperationId":"triggerNodeGatewayRoutes","summary":"Retrieve the node's active gateway routing table"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_297","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_297"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}},"schemaId":"schema_298"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-routes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_298","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_298"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodegatewayroutes"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/gateway-routes"},{"label":"Restart the IPsec daemon on the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodeipsecrestart","routeSlug":"/appliance/triggernodeipsecrestart","metadata":{"seo":{"title":"Restart the IPsec daemon on the node","description":"Executes ipsec restart on the node and streams the output. Use ?wait=1to block until the command completes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeIpsecRestart","name":"Restart the IPsec daemon on the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1ipsec-restart/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restart the IPsec daemon on the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Executes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ipsec restart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the node and streams the output. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to block until the command completes."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:ipsec-restart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1ipsec-restart/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1ipsec-restart/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/ipsec-restart","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/ipsec-restart","href":"/appliance/triggernodeipsecrestart","openApiOperationId":"triggerNodeIpsecRestart","summary":"Restart the IPsec daemon on the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1ipsec-restart/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodeipsecrestart"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/ipsec-restart"},{"label":"Retrieve the full IPsec daemon status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodeipsecstatusall","routeSlug":"/appliance/triggernodeipsecstatusall","metadata":{"seo":{"title":"Retrieve the full IPsec daemon status","description":"Executes ipsec statusall on the node and streams the output.Use ?wait=1 to block and receive the full status text."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeIpsecStatusall","name":"Retrieve the full IPsec daemon status","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1ipsec-statusall/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the full IPsec daemon status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Executes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ipsec statusall"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the node and streams the output."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block and receive the full status text."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:ipsec-statusall"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1ipsec-statusall/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1ipsec-statusall/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/ipsec-statusall","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/ipsec-statusall","href":"/appliance/triggernodeipsecstatusall","openApiOperationId":"triggerNodeIpsecStatusall","summary":"Retrieve the full IPsec daemon status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1ipsec-statusall/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodeipsecstatusall"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/ipsec-statusall"},{"label":"Retrieve or reset address-translation rule hit counts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodenathits","routeSlug":"/appliance/triggernodenathits","metadata":{"seo":{"title":"Retrieve or reset address-translation rule hit counts","description":"Returns hit counts for address translation (NAT) rules, or resets countersfor specific rules. Filter by tracker ID, network name, interface, or CIDR ranges."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeNatHits","name":"Retrieve or reset address-translation rule hit counts","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1nat-hits/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve or reset address-translation rule hit counts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns hit counts for address translation (NAT) rules, or resets counters"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for specific rules. Filter by tracker ID, network name, interface, or CIDR ranges."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:nat-hits"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1nat-hits/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1nat-hits/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_299"}},"schemaId":"schema_299","pointer":"/paths/~1node~1{nodeID}~1trigger~1nat-hits/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/nat-hits","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_299"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/nat-hits","href":"/appliance/triggernodenathits","openApiOperationId":"triggerNodeNatHits","summary":"Retrieve or reset address-translation rule hit counts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_299","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_299"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292"}},"schemaId":"schema_292"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1nat-hits/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_292","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_292"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodenathits"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/nat-hits"},{"label":"Stream plugin debug messages from the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodedebug","routeSlug":"/appliance/triggernodedebug","metadata":{"seo":{"title":"Stream plugin debug messages from the node","description":"Opens a streaming session that subscribes to internal plugin debug messages.Optionally filter by plugin name. Messages arrive formatted asHH:MM:SS.mmm: {message} lines."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeDebug","name":"Stream plugin debug messages from the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stream plugin debug messages from the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opens a streaming session that subscribes to internal plugin debug messages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally filter by plugin name. Messages arrive formatted as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM:SS.mmm: {message}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lines."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to buffer messages until the session ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:node-debug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_300"}},"schemaId":"schema_300","pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/node-debug","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_300"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/node-debug","href":"/appliance/triggernodedebug","openApiOperationId":"triggerNodeDebug","summary":"Stream plugin debug messages from the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_300","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_300"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodedebug"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/node-debug"},{"label":"Reboot the node's host operating system","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodereboot","routeSlug":"/appliance/triggernodereboot","metadata":{"seo":{"title":"Reboot the node's host operating system","description":"Schedules a host OS reboot (shutdown -r now) to execute 5 seconds afterthis call is acknowledged. The node will disconnect and come back onlineafter completing its boot sequence."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeReboot","name":"Reboot the node's host operating system","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-reboot/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reboot the node's host operating system","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schedules a host OS reboot ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shutdown -r now"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to execute 5 seconds after"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this call is acknowledged. The node will disconnect and come back online"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"after completing its boot sequence."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:node-reboot"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-reboot/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-reboot/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/node-reboot","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/node-reboot","href":"/appliance/triggernodereboot","openApiOperationId":"triggerNodeReboot","summary":"Reboot the node's host operating system"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_301"}},"schemaId":"schema_301"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-reboot/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_301","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_301"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodereboot"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/node-reboot"},{"label":"Restart the Trustgrid node service process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernoderestartservice","routeSlug":"/appliance/triggernoderestartservice","metadata":{"seo":{"title":"Restart the Trustgrid node service process","description":"Causes the Trustgrid node agent process to exit and restart. The node willbriefly disconnect while the service restarts."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeRestartService","name":"Restart the Trustgrid node service process","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-restart-service/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restart the Trustgrid node service process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Causes the Trustgrid node agent process to exit and restart. The node will"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"briefly disconnect while the service restarts."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:node-restart-service"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-restart-service/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-restart-service/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/node-restart-service","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/node-restart-service","href":"/appliance/triggernoderestartservice","openApiOperationId":"triggerNodeRestartService","summary":"Restart the Trustgrid node service process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_302"}},"schemaId":"schema_302"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-restart-service/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_302","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_302"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernoderestartservice"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/node-restart-service"},{"label":"Trigger an immediate software upgrade of the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodeupgrade","routeSlug":"/appliance/triggernodeupgrade","metadata":{"seo":{"title":"Trigger an immediate software upgrade of the node","description":"Forces the node to run its upgrade process immediately, bypassing the normalscheduled unattended-upgrade window. If an upgrade is already in progress,returns a status message indicating so."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeUpgrade","name":"Trigger an immediate software upgrade of the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-upgrade/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Trigger an immediate software upgrade of the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Forces the node to run its upgrade process immediately, bypassing the normal"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"scheduled unattended-upgrade window. If an upgrade is already in progress,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"returns a status message indicating so."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:node-upgrade"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-upgrade/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-upgrade/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_303"}},"schemaId":"schema_303","pointer":"/paths/~1node~1{nodeID}~1trigger~1node-upgrade/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/node-upgrade","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_303"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/node-upgrade","href":"/appliance/triggernodeupgrade","openApiOperationId":"triggerNodeUpgrade","summary":"Trigger an immediate software upgrade of the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_303","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_303"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304"}},"schemaId":"schema_304"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-upgrade/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_304","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_304"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodeupgrade"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/node-upgrade"},{"label":"Measure the node's internet bandwidth to the Trustgrid control plane","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodespeedtest","routeSlug":"/appliance/triggernodespeedtest","metadata":{"seo":{"title":"Measure the node's internet bandwidth to the Trustgrid control plane","description":"Runs a download and/or upload throughput test between the node and theTrustgrid control plane speed-test endpoints. Results stream as JSON objectscontaining downloadMbps, maxDownloadMbps, uploadMbps, and maxUploadMbps."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeSpeedTest","name":"Measure the node's internet bandwidth to the Trustgrid control plane","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1speed-test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Measure the node's internet bandwidth to the Trustgrid control plane","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runs a download and/or upload throughput test between the node and the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trustgrid control plane speed-test endpoints. Results stream as JSON objects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"containing "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"downloadMbps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxDownloadMbps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uploadMbps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"maxUploadMbps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the test completes and receive the full output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:speed-test"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1speed-test/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1speed-test/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_305"}},"schemaId":"schema_305","pointer":"/paths/~1node~1{nodeID}~1trigger~1speed-test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/speed-test","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_305"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/speed-test","href":"/appliance/triggernodespeedtest","openApiOperationId":"triggerNodeSpeedTest","summary":"Measure the node's internet bandwidth to the Trustgrid control plane"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_305","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_305"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1speed-test/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodespeedtest"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/speed-test"},{"label":"Send ARP ping to a host from the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodetgarping","routeSlug":"/appliance/triggernodetgarping","metadata":{"seo":{"title":"Send ARP ping to a host from the node","description":"Runs arping -i {iface} {host} on the node and streams the output.Useful for verifying Layer 2 reachability on a given interface."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeTgArping","name":"Send ARP ping to a host from the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-arping/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send ARP ping to a host from the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"arping -i {iface} {host}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the node and streams the output."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Useful for verifying Layer 2 reachability on a given interface."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block and receive the command output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:tg-arping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-arping/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-arping/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_306"}},"schemaId":"schema_306","pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-arping/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/tg-arping","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_306"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/tg-arping","href":"/appliance/triggernodetgarping","openApiOperationId":"triggerNodeTgArping","summary":"Send ARP ping to a host from the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_306","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_306"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-arping/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodetgarping"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/tg-arping"},{"label":"Run an MTR network diagnostic from the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodetgmtr","routeSlug":"/appliance/triggernodetgmtr","metadata":{"seo":{"title":"Run an MTR network diagnostic from the node","description":"Starts an interactive MTR (Matt's Traceroute) session to the specified host.Results stream as terminal output."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeTgMtr","name":"Run an MTR network diagnostic from the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-mtr/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run an MTR network diagnostic from the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts an interactive MTR (Matt's Traceroute) session to the specified host."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results stream as terminal output."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block and receive the buffered MTR output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:tg-mtr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-mtr/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-mtr/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_307"}},"schemaId":"schema_307","pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-mtr/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/tg-mtr","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_307"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/tg-mtr","href":"/appliance/triggernodetgmtr","openApiOperationId":"triggerNodeTgMtr","summary":"Run an MTR network diagnostic from the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_307","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_307"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-mtr/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodetgmtr"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/tg-mtr"},{"label":"Test TCP port connectivity from the node's local network","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodetgnc","routeSlug":"/appliance/triggernodetgnc","metadata":{"seo":{"title":"Test TCP port connectivity from the node's local network","description":"Runs nc -v -z {host} {port} from the node, binding to the specified sourceaddress. Returns the netcat output and exit code."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeTgNc","name":"Test TCP port connectivity from the node's local network","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-nc/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test TCP port connectivity from the node's local network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nc -v -z {host} {port}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the node, binding to the specified source"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"address. Returns the netcat output and exit code."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block and receive the result synchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:tg-nc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-nc/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-nc/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_308"}},"schemaId":"schema_308","pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-nc/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/tg-nc","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_308"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/tg-nc","href":"/appliance/triggernodetgnc","openApiOperationId":"triggerNodeTgNc","summary":"Test TCP port connectivity from the node's local network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_308","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_308"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_309"}},"schemaId":"schema_309"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-nc/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_309","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_309"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodetgnc"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/tg-nc"},{"label":"Test TCP port connectivity from inside a virtual network namespace","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodetgnetnc","routeSlug":"/appliance/triggernodetgnetnc","metadata":{"seo":{"title":"Test TCP port connectivity from inside a virtual network namespace","description":"Runs nc -v -z {host} {port} inside the management namespace for the specifiedvirtual network, testing connectivity as seen from that network context."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeTgNetNc","name":"Test TCP port connectivity from inside a virtual network namespace","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-nc/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test TCP port connectivity from inside a virtual network namespace","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nc -v -z {host} {port}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" inside the management namespace for the specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"virtual network, testing connectivity as seen from that network context."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block and receive the result synchronously."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:tg-net-nc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-nc/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-nc/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_310"}},"schemaId":"schema_310","pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-nc/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/tg-net-nc","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_310"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/tg-net-nc","href":"/appliance/triggernodetgnetnc","openApiOperationId":"triggerNodeTgNetNc","summary":"Test TCP port connectivity from inside a virtual network namespace"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_310","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_310"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_309"}},"schemaId":"schema_309"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-nc/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_309","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_309"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodetgnetnc"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/tg-net-nc"},{"label":"Ping a host through a virtual network namespace on the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodetgnetping","routeSlug":"/appliance/triggernodetgnetping","metadata":{"seo":{"title":"Ping a host through a virtual network namespace on the node","description":"Runs ip netns exec mgmt-{network} ping {host} on the node, testingreachability from inside the specified virtual network context.Output streams as terminal text."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeTgNetPing","name":"Ping a host through a virtual network namespace on the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-ping/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ping a host through a virtual network namespace on the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip netns exec mgmt-{network} ping {host}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the node, testing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reachability from inside the specified virtual network context."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Output streams as terminal text."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block and receive the output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:tg-net-ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-ping/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-ping/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_311"}},"schemaId":"schema_311","pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-ping/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/tg-net-ping","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_311"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/tg-net-ping","href":"/appliance/triggernodetgnetping","openApiOperationId":"triggerNodeTgNetPing","summary":"Ping a host through a virtual network namespace on the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_311","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_311"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-net-ping/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodetgnetping"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/tg-net-ping"},{"label":"Ping a host from the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodetgping","routeSlug":"/appliance/triggernodetgping","metadata":{"seo":{"title":"Ping a host from the node","description":"Runs ping -O -I {source} {host} on the node and streams the output.Use ?wait=1 to block and receive the ping output."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeTgPing","name":"Ping a host from the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-ping/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ping a host from the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ping -O -I {source} {host}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the node and streams the output."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block and receive the ping output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:tg-ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-ping/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-ping/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_312"}},"schemaId":"schema_312","pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-ping/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/tg-ping","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_312"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/tg-ping","href":"/appliance/triggernodetgping","openApiOperationId":"triggerNodeTgPing","summary":"Ping a host from the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_312","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_312"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-ping/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodetgping"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/tg-ping"},{"label":"Capture packets on the node using tcpdump","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodetgtcpdump","routeSlug":"/appliance/triggernodetgtcpdump","metadata":{"seo":{"title":"Capture packets on the node using tcpdump","description":"Starts a streaming tcpdump capture session on the node. Captured packetdetails stream as text output. Use ?wait=1 to buffer until the capture ends."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeTgTcpdump","name":"Capture packets on the node using tcpdump","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-tcpdump/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Capture packets on the node using tcpdump","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts a streaming tcpdump capture session on the node. Captured packet"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"details stream as text output. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to buffer until the capture ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:tg-tcpdump"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-tcpdump/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-tcpdump/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_313"}},"schemaId":"schema_313","pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-tcpdump/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/tg-tcpdump","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_313"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/tg-tcpdump","href":"/appliance/triggernodetgtcpdump","openApiOperationId":"triggerNodeTgTcpdump","summary":"Capture packets on the node using tcpdump"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_313","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_313"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-tcpdump/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodetgtcpdump"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/tg-tcpdump"},{"label":"Run a traceroute from the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodetgtraceroute","routeSlug":"/appliance/triggernodetgtraceroute","metadata":{"seo":{"title":"Run a traceroute from the node","description":"Runs traceroute to the specified host from the node and streams the output.Use ?wait=1 to block and receive the full traceroute output."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeTgTraceroute","name":"Run a traceroute from the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-traceroute/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run a traceroute from the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runs "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"traceroute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the specified host from the node and streams the output."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block and receive the full traceroute output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:tg-traceroute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-traceroute/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-traceroute/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_314"}},"schemaId":"schema_314","pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-traceroute/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/tg-traceroute","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_314"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/tg-traceroute","href":"/appliance/triggernodetgtraceroute","openApiOperationId":"triggerNodeTgTraceroute","summary":"Run a traceroute from the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_314","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_314"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1tg-traceroute/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodetgtraceroute"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/tg-traceroute"},{"label":"Stream virtual network packet captures from the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodevpndump","routeSlug":"/appliance/triggernodevpndump","metadata":{"seo":{"title":"Stream virtual network packet captures from the node","description":"Opens a streaming session that outputs VPN packet details in a tcpdump-likeformat. Filter by network, protocol, peer, host, port, TCP flags, or session ID.The session stays open until closed by the client."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeVpnDump","name":"Stream virtual network packet captures from the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-dump/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stream virtual network packet captures from the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opens a streaming session that outputs VPN packet details in a tcpdump-like"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"format. Filter by network, protocol, peer, host, port, TCP flags, or session ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The session stays open until closed by the client."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to buffer output until the session ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:vpn-dump"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-dump/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-dump/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_315"}},"schemaId":"schema_315","pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-dump/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/vpn-dump","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_315"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/vpn-dump","href":"/appliance/triggernodevpndump","openApiOperationId":"triggerNodeVpnDump","summary":"Stream virtual network packet captures from the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_315","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_315"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-dump/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodevpndump"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/vpn-dump"},{"label":"Get, generate, or save a Wireguard key for a virtual network","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodevpnkey","routeSlug":"/appliance/triggernodevpnkey","metadata":{"seo":{"title":"Get, generate, or save a Wireguard key for a virtual network","description":"Manages the X25519 Wireguard private key for a virtual network interface."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeVpnKey","name":"Get, generate, or save a Wireguard key for a virtual network","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-key/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get, generate, or save a Wireguard key for a virtual network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manages the X25519 Wireguard private key for a virtual network interface."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"get"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — returns the current public key as a JWK"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — generates a new private key, saves it, and returns the public key"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"save"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — saves the provided base64-encoded 32-byte private key and returns the public key"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:vpn-key"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-key/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-key/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_316"}},"schemaId":"schema_316","pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-key/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/vpn-key","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_316"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/vpn-key","href":"/appliance/triggernodevpnkey","openApiOperationId":"triggerNodeVpnKey","summary":"Get, generate, or save a Wireguard key for a virtual network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_316","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_316"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_317"}},"schemaId":"schema_317"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-key/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_317","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_317"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodevpnkey"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/vpn-key"},{"label":"Retrieve the NAT translation table for a virtual network","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodevpnnats","routeSlug":"/appliance/triggernodevpnnats","metadata":{"seo":{"title":"Retrieve the NAT translation table for a virtual network","description":"Returns the active network address translation (NAT) table for the specifiedvirtual network, showing TCP and UDP flow mappings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeVpnNats","name":"Retrieve the NAT translation table for a virtual network","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-nats/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the NAT translation table for a virtual network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the active network address translation (NAT) table for the specified"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"virtual network, showing TCP and UDP flow mappings."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:vpn-nats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-nats/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-nats/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_318"}},"schemaId":"schema_318","pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-nats/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/vpn-nats","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_318"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/vpn-nats","href":"/appliance/triggernodevpnnats","openApiOperationId":"triggerNodeVpnNats","summary":"Retrieve the NAT translation table for a virtual network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_318","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_318"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_319"}},"schemaId":"schema_319"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-nats/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_319","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_319"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodevpnnats"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/vpn-nats"},{"label":"Retrieve the virtual network routing table","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodevpnroutes","routeSlug":"/appliance/triggernodevpnroutes","metadata":{"seo":{"title":"Retrieve the virtual network routing table","description":"Returns routes for one or all virtual networks, with optional filtering bynetwork name, network ID, destination IP, or destination node name."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeVpnRoutes","name":"Retrieve the virtual network routing table","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-routes/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the virtual network routing table","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns routes for one or all virtual networks, with optional filtering by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"network name, network ID, destination IP, or destination node name."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:vpn-routes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-routes/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-routes/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_320"}},"schemaId":"schema_320","pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-routes/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/vpn-routes","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_320"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/vpn-routes","href":"/appliance/triggernodevpnroutes","openApiOperationId":"triggerNodeVpnRoutes","summary":"Retrieve the virtual network routing table"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_320","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_320"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_321"}},"schemaId":"schema_321"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1vpn-routes/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_321","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_321"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodevpnroutes"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/vpn-routes"},{"label":"List or terminate active Wireguard ZTNA client sessions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/triggernodewgclients","routeSlug":"/appliance/triggernodewgclients","metadata":{"seo":{"title":"List or terminate active Wireguard ZTNA client sessions","description":"Returns active Wireguard client (ZTNA) sessions on the node's virtual networks,optionally filtered by network, application ID, or session ID.Setting action to kill terminates matching sessions instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeWgClients","name":"List or terminate active Wireguard ZTNA client sessions","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1wg-clients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List or terminate active Wireguard ZTNA client sessions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns active Wireguard client (ZTNA) sessions on the node's virtual networks,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"optionally filtered by network, application ID, or session ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" terminates matching sessions instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:wg-clients"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1wg-clients/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1wg-clients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_322"}},"schemaId":"schema_322","pointer":"/paths/~1node~1{nodeID}~1trigger~1wg-clients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/wg-clients","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_322"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/wg-clients","href":"/appliance/triggernodewgclients","openApiOperationId":"triggerNodeWgClients","summary":"List or terminate active Wireguard ZTNA client sessions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_322","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_322"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}},"schemaId":"schema_323"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1wg-clients/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_323","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_323"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/triggernodewgclients"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/wg-clients"},{"label":"Execute a remote operation or command on a specific node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1node~1{nodeid}~1trigger~1{event}/post","routeSlug":"/appliance/paths/~1node~1{nodeid}~1trigger~1{event}/post","metadata":{"seo":{"title":"Execute a remote operation or command on a specific node","description":"Sends an event to the node and optionally waits for its response. Use thededicated event endpoints (e.g. /node/{nodeID}/trigger/gateway-routes) fordocumented events with typed request and response schemas."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Execute a remote operation or command on a specific node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute a remote operation or command on a specific node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends an event to the node and optionally waits for its response. Use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dedicated event endpoints (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/node/{nodeID}/trigger/gateway-routes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documented events with typed request and response schemas."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event=bgp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the backend currently supports:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action: get"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — return BGP runtime status, peer sessions, learned routes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejected routes, and advertised prefixes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action: restart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restart the BGP service on the node"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds (useful for synchronous checks)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All services require either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:{event}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"event","in":"path","schemaId":"schema_324","description":"Event name to trigger on the node. This parameter is open-ended; the backend\nmay support additional event names beyond those with dedicated endpoints.","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output. Omit for fire-and-forget."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_325"}},"schemaId":"schema_325","pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/{event}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"event","in":"path","required":true,"example":"gateway-routes","schemaId":"schema_324"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_325"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/{event}","href":"/appliance/paths/~1node~1{nodeid}~1trigger~1{event}/post","summary":"Execute a remote operation or command on a specific node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_325","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_325"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}},"schemaId":"schema_326"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_326","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1node~1{nodeid}~1trigger~1{event}/post"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/{event}"},{"label":"Retrieve real-time network usage statistics and bandwidth metrics for nodes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/getrealtimeusage","routeSlug":"/appliance/getrealtimeusage","metadata":{"seo":{"title":"Retrieve real-time network usage statistics and bandwidth metrics for nodes","description":"Returns an array of usage data buckets for specified nodes within the specified time range and interval."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRealtimeUsage","name":"Retrieve real-time network usage statistics and bandwidth metrics for nodes","isWebhook":false,"pointer":"/paths/~1stats~1realtime~1usage/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve real-time network usage statistics and bandwidth metrics for nodes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns an array of usage data buckets for specified nodes within the specified time range and interval."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"relative_start","in":"query","schemaId":"schema_240","description":"The relative start time for the data (e.g., \"-7 days\")."},{"name":"relative_end","in":"query","schemaId":"schema_240","description":"The relative end time for the data (e.g., \"now\")."},{"name":"intervalInMinutes","in":"query","schemaId":"schema_240","description":"The size of the time buckets in minutes."},{"name":"start","in":"query","schemaId":"schema_327","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start time for the data in Unix timestamp format (if not using relative_start)."},"children":[]}]}]}]},{"name":"end","in":"query","schemaId":"schema_327","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The end time for the data in Unix timestamp format (if not using relative_end)."},"children":[]}]}]}]},{"name":"filters","in":"query","schemaId":"schema_240","description":"The filters to apply when querying for nodes, like tags."}],"pointer":"/paths/~1stats~1realtime~1usage/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/stats/realtime/usage","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"relative_start","in":"query","schemaId":"schema_240"},{"name":"relative_end","in":"query","schemaId":"schema_240"},{"name":"intervalInMinutes","in":"query","schemaId":"schema_240"},{"name":"start","in":"query","schemaId":"schema_327"},{"name":"end","in":"query","schemaId":"schema_327"},{"name":"filters","in":"query","schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/stats/realtime/usage","href":"/appliance/getrealtimeusage","openApiOperationId":"getRealtimeUsage","summary":"Retrieve real-time network usage statistics and bandwidth metrics for nodes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An array of usage data buckets.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}},"schemaId":"schema_328"}],"pointer":"/paths/~1stats~1realtime~1usage/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_328","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_328"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/getrealtimeusage"}],"panels":[]}]},"httpPath":"/stats/realtime/usage"},{"label":"Delete a file or directory","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store/delete","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store/delete","metadata":{"seo":{"title":"Delete a file or directory","description":"Requires nodes::service:datastore-manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a file or directory","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store/delete","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a file or directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:datastore-manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store/delete/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329","pointer":"/paths/~1v2~1node~1{nodeID}~1data-store/delete/requestBody","description":"rm"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/data-store","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_329"}},"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/data-store","href":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store/delete","summary":"Delete a file or directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/data-store"},{"label":"Copy a file from an HTTP location to the data store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-download/post","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-download/post","metadata":{"seo":{"title":"Copy a file from an HTTP location to the data store","description":"Requires nodes::service:datastore-manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Copy a file from an HTTP location to the data store","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1http-download/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy a file from an HTTP location to the data store","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:datastore-manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1http-download/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_330"}},"schemaId":"schema_330","pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1http-download/post/requestBody","description":"Download config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/data-store/http-download","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_330"}},"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/data-store/http-download","href":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-download/post","summary":"Copy a file from an HTTP location to the data store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_330","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_330"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1http-download/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-download/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/data-store/http-download"},{"label":"Upload a file from the node to an HTTP endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-upload/post","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-upload/post","metadata":{"seo":{"title":"Upload a file from the node to an HTTP endpoint","description":"Requires nodes::service:datastore-manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upload a file from the node to an HTTP endpoint","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1http-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a file from the node to an HTTP endpoint","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:datastore-manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1http-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"schemaId":"schema_331","pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1http-upload/post/requestBody","description":"Upload config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/data-store/http-upload","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_331"}},"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/data-store/http-upload","href":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-upload/post","summary":"Upload a file from the node to an HTTP endpoint"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_331","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_331"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1http-upload/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-upload/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/data-store/http-upload"},{"label":"List the data store contents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/listnodedatastorecontents","routeSlug":"/appliance/listnodedatastorecontents","metadata":{"seo":{"title":"List the data store contents","description":"Requires nodes::service:datastore-manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeDataStoreContents","name":"List the data store contents","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the data store contents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:datastore-manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/data-store/list","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/data-store/list","href":"/appliance/listnodedatastorecontents","openApiOperationId":"listNodeDataStoreContents","summary":"List the data store contents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}},"schemaId":"schema_332"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1list/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_332","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_332"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/listnodedatastorecontents"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/data-store/list"},{"label":"Create a directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1mkdir/post","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1mkdir/post","metadata":{"seo":{"title":"Create a directory","description":"Requires nodes::service:datastore-manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a directory","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1mkdir/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a directory","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:datastore-manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1mkdir/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"schemaId":"schema_329","pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1mkdir/post/requestBody","description":"mkdir"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/data-store/mkdir","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_329"}},"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/data-store/mkdir","href":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1mkdir/post","summary":"Create a directory"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_329","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_329"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1mkdir/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1mkdir/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/data-store/mkdir"},{"label":"Copy a file from S3 to the data store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-download/post","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-download/post","metadata":{"seo":{"title":"Copy a file from S3 to the data store","description":"Requires nodes::service:datastore-manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Copy a file from S3 to the data store","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1s3-download/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Copy a file from S3 to the data store","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:datastore-manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1s3-download/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_333"}},"schemaId":"schema_333","pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1s3-download/post/requestBody","description":"Download config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/data-store/s3-download","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_333"}},"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/data-store/s3-download","href":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-download/post","summary":"Copy a file from S3 to the data store"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_333","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_333"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1s3-download/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-download/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/data-store/s3-download"},{"label":"Upload a file from the node to an S3 bucket","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-upload/post","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-upload/post","metadata":{"seo":{"title":"Upload a file from the node to an S3 bucket","description":"Requires nodes::service:datastore-manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upload a file from the node to an S3 bucket","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1s3-upload/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload a file from the node to an S3 bucket","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:datastore-manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1s3-upload/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_334"}},"schemaId":"schema_334","pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1s3-upload/post/requestBody","description":"Upload config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/data-store/s3-upload","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_334"}},"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/data-store/s3-upload","href":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-upload/post","summary":"Upload a file from the node to an S3 bucket"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_334","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_334"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1s3-upload/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-upload/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/data-store/s3-upload"},{"label":"List recent data store activity","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/listnodedatastoretasks","routeSlug":"/appliance/listnodedatastoretasks","metadata":{"seo":{"title":"List recent data store activity","description":"Requires nodes::service:datastore-manager permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeDataStoreTasks","name":"List recent data store activity","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1tasks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List recent data store activity","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:datastore-manager"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1tasks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/data-store/tasks","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/data-store/tasks","href":"/appliance/listnodedatastoretasks","openApiOperationId":"listNodeDataStoreTasks","summary":"List recent data store activity"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}},"schemaId":"schema_335"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1data-store~1tasks/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_335","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_335"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/listnodedatastoretasks"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/data-store/tasks"},{"label":"Get per-minute gateway RTT telemetry for a node's VPN peer connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/getnodegatewaydetails","routeSlug":"/appliance/getnodegatewaydetails","metadata":{"seo":{"title":"Get per-minute gateway RTT telemetry for a node's VPN peer connections","description":"Returns time-series RTT (round-trip time) statistics for each VPN peerthe node is connected to. Each element covers one minute bucket.Results are only available for online appliance nodes."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeGatewayDetails","name":"Get per-minute gateway RTT telemetry for a node's VPN peer connections","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1plugin-logs~1gateway-details/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get per-minute gateway RTT telemetry for a node's VPN peer connections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns time-series RTT (round-trip time) statistics for each VPN peer"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the node is connected to. Each element covers one minute bucket."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are only available for online appliance nodes."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1plugin-logs~1gateway-details/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"startDate","in":"query","schemaId":"schema_246","description":"Start of the time range as a Unix timestamp (seconds)","required":true},{"name":"endDate","in":"query","schemaId":"schema_246","description":"End of the time range as a Unix timestamp (seconds)","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1plugin-logs~1gateway-details/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/plugin-logs/gateway-details","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"startDate","in":"query","required":true,"schemaId":"schema_246"},{"name":"endDate","in":"query","required":true,"schemaId":"schema_246"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/plugin-logs/gateway-details","href":"/appliance/getnodegatewaydetails","openApiOperationId":"getNodeGatewayDetails","summary":"Get per-minute gateway RTT telemetry for a node's VPN peer connections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}},"schemaId":"schema_336"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1plugin-logs~1gateway-details/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_336","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_336"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/getnodegatewaydetails"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/plugin-logs/gateway-details"},{"label":"Update the lifecycle state of a specific node","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put","routeSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put","metadata":{"seo":{"title":"Update the lifecycle state of a specific node","description":"Update the lifecycle state for a node (appliance or agent)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update the lifecycle state of a specific node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1lifecycle-state/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the lifecycle state of a specific node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the lifecycle state for a node (appliance or agent)."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1lifecycle-state/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LifecycleStateRequest"}},"schemaId":"components/schemas/LifecycleStateRequest","pointer":"/paths/~1v2~1node~1{nodeID}~1lifecycle-state/put/requestBody","description":"Lifecycle state update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/lifecycle-state","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LifecycleStateRequest"}},"responseCodes":["200","404","422"],"pointer":"/v2/node/{nodeID}/lifecycle-state","href":"/appliance/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put","summary":"Update the lifecycle state of a specific node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/LifecycleStateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LifecycleStateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1lifecycle-state/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/lifecycle-state"}],"content":{"contentType":"group","meta":{"name":"Appliance"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Appliance","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/nodes/appliances/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appliances"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are physical or virtual machine Trustgrid nodes providing full network, VPN, edge compute, and monitoring capabilities. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/node","summary":"Retrieve all network nodes including appliances and agents with filtering options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance/listnodes","deprecated":false},{"title":"/node/license","summary":"Generate a license key for registering a new node to the organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance/getnodelicense","deprecated":false},{"title":"/node/by-fqdn/{fqdn}","summary":"Retrieve a node by its fully-qualified domain name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance/getnodebyfqdn","deprecated":false},{"title":"/node/{nodeID}","summary":"Permanently remove a node from the organization and revoke access","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}/delete","deprecated":false},{"title":"/node/{nodeID}","summary":"Retrieve detailed configuration and status information for a specific node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance/getnode","deprecated":false},{"title":"/node/{nodeID}","summary":"Modify node settings including cluster assignment and operational state","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}/put","deprecated":false},{"title":"/node/{nodeID}/config/alert","summary":"Configure alert thresholds and notification settings for a specific appliance","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1config~1alert/put","deprecated":false},{"title":"/node/{nodeID}/config/cluster","summary":"Configure high-availability cluster settings for a specific appliance","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1config~1cluster/put","deprecated":false},{"title":"/node/{nodeID}/config/connectors","summary":"Configure inbound network connectors for external access to node services","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/put","deprecated":false},{"title":"/node/{nodeID}/config/connectors","summary":"Remove all connector configurations from a node","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1config~1connectors/delete","deprecated":false},{"title":"/v2/node/{nodeID}/config/connectors","summary":"Create a new inbound connector to expose services running on the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors/post","deprecated":false},{"title":"/v2/node/{nodeID}/config/connectors/upgrade","summary":"Migrate a node's connector configuration to the latest V2 format","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post","deprecated":false},{"title":"/v2/node/{nodeID}/config/connectors/{connectorID}","summary":"Modify settings for an existing connector on a node","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put","deprecated":false},{"title":"/v2/node/{nodeID}/config/connectors/{connectorID}","summary":"Remove a specific connector configuration from a node","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete","deprecated":false},{"title":"/node/{nodeID}/config/network","summary":"Configure network interfaces, routing, and firewall rules for an appliance","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1config~1network/put","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp","summary":"Configure the BGP routing plugin on an appliance","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/updatenodebgpconfig","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-groups","summary":"Create a BGP peer group on a node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/createnodebgppeergroup","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}","summary":"Delete a BGP peer group from a node","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/deletenodebgppeergroup","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peers","summary":"Create a BGP peer in a peer group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/createnodebgppeer","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peers/{peerId}","summary":"Update a BGP peer in a peer group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/updatenodebgppeer","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/peer/{peerId}","summary":"Delete a BGP peer from a peer group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/deletenodebgppeer","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policies","summary":"Create an import policy in a BGP peer group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/createnodebgpimportpolicy","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policies/{policyId}","summary":"Update an import policy in a BGP peer group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/updatenodebgpimportpolicy","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}","summary":"Delete an import policy from a BGP peer group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/deletenodebgpimportpolicy","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefixes","summary":"Create an import policy prefix match","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/createnodebgpimportpolicyprefix","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefixes/{prefixId}","summary":"Update an import policy prefix match","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/updatenodebgpimportpolicyprefix","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/import-policy/{importPolicyId}/match/prefix/{prefixId}","summary":"Delete an import policy prefix match","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/deletenodebgpimportpolicyprefix","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policies","summary":"Create an export policy in a BGP peer group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/createnodebgpexportpolicy","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policies/{policyId}","summary":"Update an export policy in a BGP peer group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/updatenodebgpexportpolicy","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}","summary":"Delete an export policy from a BGP peer group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/deletenodebgpexportpolicy","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefixes","summary":"Create an export policy prefix","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/createnodebgpexportpolicyprefix","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefixes/{prefixId}","summary":"Update an export policy prefix","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/updatenodebgpexportpolicyprefix","deprecated":false},{"title":"/v2/node/{nodeID}/config/network/bgp/peer-group/{peerGroupId}/export-policy/{exportPolicyId}/match/prefix/{prefixId}","summary":"Delete an export policy prefix","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/deletenodebgpexportpolicyprefix","deprecated":false},{"title":"/node/{nodeID}/config/services","summary":"Configure outbound services for external connections from the node","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1config~1services/put","deprecated":false},{"title":"/v2/node/{nodeID}/config/services","summary":"Create a new outbound service connection for external resource access","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services/post","deprecated":false},{"title":"/v2/node/{nodeID}/config/services/upgrade","summary":"Migrate a node's service configuration to the latest V2 format","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post","deprecated":false},{"title":"/v2/node/{nodeID}/config/services/{serviceID}","summary":"Modify settings for an existing service connection on a node","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put","deprecated":false},{"title":"/v2/node/{nodeID}/config/services/{serviceID}","summary":"Remove a specific service configuration from a node","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete","deprecated":false},{"title":"/node/{nodeID}/config/ztnagw","summary":"Configure Zero Trust Network Access gateway settings for secure remote access","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/put","deprecated":false},{"title":"/node/{nodeID}/config/ztnagw","summary":"Remove APIGW gateway configuration and disable secure remote access","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1config~1ztnagw/delete","deprecated":false},{"title":"/node/{nodeID}/config/gateway","summary":"Configure node as a network gateway for routing traffic between networks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1config~1gateway/put","deprecated":false},{"title":"/node/{nodeID}/snmp","summary":"Configure SNMP monitoring settings for network management integration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1snmp/put","deprecated":false},{"title":"/node/{nodeID}/tag/{tagName}","summary":"Remove a metadata tag from a node for organizational categorization","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/delete","deprecated":false},{"title":"/node/{nodeID}/tag/{tagName}","summary":"Add or update a metadata tag on a node for organizational categorization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1tag~1{tagname}/put","deprecated":false},{"title":"/node/{nodeID}/trigger/aws-route-tables","summary":"List AWS route tables attached to the node host","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodeawsroutetables","deprecated":false},{"title":"/node/{nodeID}/trigger/datastore-manager","summary":"Manage the node's local datastore files","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodedatastoremanager","deprecated":false},{"title":"/node/{nodeID}/trigger/flows","summary":"View or delete active network flows on the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodeflows","deprecated":false},{"title":"/node/{nodeID}/trigger/gateway-perf","summary":"Run a throughput performance test to a peer gateway node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodegatewayperf","deprecated":false},{"title":"/node/{nodeID}/trigger/gateway-ping","summary":"Ping a peer gateway node over the Trustgrid overlay","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodegatewayping","deprecated":false},{"title":"/node/{nodeID}/trigger/gateway-routes","summary":"Retrieve the node's active gateway routing table","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodegatewayroutes","deprecated":false},{"title":"/node/{nodeID}/trigger/ipsec-restart","summary":"Restart the IPsec daemon on the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodeipsecrestart","deprecated":false},{"title":"/node/{nodeID}/trigger/ipsec-statusall","summary":"Retrieve the full IPsec daemon status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodeipsecstatusall","deprecated":false},{"title":"/node/{nodeID}/trigger/nat-hits","summary":"Retrieve or reset address-translation rule hit counts","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodenathits","deprecated":false},{"title":"/node/{nodeID}/trigger/node-debug","summary":"Stream plugin debug messages from the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodedebug","deprecated":false},{"title":"/node/{nodeID}/trigger/node-reboot","summary":"Reboot the node's host operating system","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodereboot","deprecated":false},{"title":"/node/{nodeID}/trigger/node-restart-service","summary":"Restart the Trustgrid node service process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernoderestartservice","deprecated":false},{"title":"/node/{nodeID}/trigger/node-upgrade","summary":"Trigger an immediate software upgrade of the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodeupgrade","deprecated":false},{"title":"/node/{nodeID}/trigger/speed-test","summary":"Measure the node's internet bandwidth to the Trustgrid control plane","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodespeedtest","deprecated":false},{"title":"/node/{nodeID}/trigger/tg-arping","summary":"Send ARP ping to a host from the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodetgarping","deprecated":false},{"title":"/node/{nodeID}/trigger/tg-mtr","summary":"Run an MTR network diagnostic from the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodetgmtr","deprecated":false},{"title":"/node/{nodeID}/trigger/tg-nc","summary":"Test TCP port connectivity from the node's local network","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodetgnc","deprecated":false},{"title":"/node/{nodeID}/trigger/tg-net-nc","summary":"Test TCP port connectivity from inside a virtual network namespace","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodetgnetnc","deprecated":false},{"title":"/node/{nodeID}/trigger/tg-net-ping","summary":"Ping a host through a virtual network namespace on the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodetgnetping","deprecated":false},{"title":"/node/{nodeID}/trigger/tg-ping","summary":"Ping a host from the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodetgping","deprecated":false},{"title":"/node/{nodeID}/trigger/tg-tcpdump","summary":"Capture packets on the node using tcpdump","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodetgtcpdump","deprecated":false},{"title":"/node/{nodeID}/trigger/tg-traceroute","summary":"Run a traceroute from the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodetgtraceroute","deprecated":false},{"title":"/node/{nodeID}/trigger/vpn-dump","summary":"Stream virtual network packet captures from the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodevpndump","deprecated":false},{"title":"/node/{nodeID}/trigger/vpn-key","summary":"Get, generate, or save a Wireguard key for a virtual network","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodevpnkey","deprecated":false},{"title":"/node/{nodeID}/trigger/vpn-nats","summary":"Retrieve the NAT translation table for a virtual network","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodevpnnats","deprecated":false},{"title":"/node/{nodeID}/trigger/vpn-routes","summary":"Retrieve the virtual network routing table","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodevpnroutes","deprecated":false},{"title":"/node/{nodeID}/trigger/wg-clients","summary":"List or terminate active Wireguard ZTNA client sessions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/triggernodewgclients","deprecated":false},{"title":"/node/{nodeID}/trigger/{event}","summary":"Execute a remote operation or command on a specific node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1node~1{nodeid}~1trigger~1{event}/post","deprecated":false},{"title":"/stats/realtime/usage","summary":"Retrieve real-time network usage statistics and bandwidth metrics for nodes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance/getrealtimeusage","deprecated":false},{"title":"/v2/node/{nodeID}/data-store","summary":"Delete a file or directory","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store/delete","deprecated":false},{"title":"/v2/node/{nodeID}/data-store/http-download","summary":"Copy a file from an HTTP location to the data store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-download/post","deprecated":false},{"title":"/v2/node/{nodeID}/data-store/http-upload","summary":"Upload a file from the node to an HTTP endpoint","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1http-upload/post","deprecated":false},{"title":"/v2/node/{nodeID}/data-store/list","summary":"List the data store contents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance/listnodedatastorecontents","deprecated":false},{"title":"/v2/node/{nodeID}/data-store/mkdir","summary":"Create a directory","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1mkdir/post","deprecated":false},{"title":"/v2/node/{nodeID}/data-store/s3-download","summary":"Copy a file from S3 to the data store","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-download/post","deprecated":false},{"title":"/v2/node/{nodeID}/data-store/s3-upload","summary":"Upload a file from the node to an S3 bucket","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1data-store~1s3-upload/post","deprecated":false},{"title":"/v2/node/{nodeID}/data-store/tasks","summary":"List recent data store activity","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance/listnodedatastoretasks","deprecated":false},{"title":"/v2/node/{nodeID}/plugin-logs/gateway-details","summary":"Get per-minute gateway RTT telemetry for a node's VPN peer connections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance/getnodegatewaydetails","deprecated":false},{"title":"/v2/node/{nodeID}/lifecycle-state","summary":"Update the lifecycle state of a specific node","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put","deprecated":false}]}]}]}]}},{"type":"group","label":"VPN","link":"/appliance-greater-vpn","routeSlug":"/appliance-greater-vpn","items":[{"label":"List all VPN networks attached to a node, including IP assignments and routing","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/listnodevpnnetworks","routeSlug":"/appliance-greater-vpn/listnodevpnnetworks","metadata":{"seo":{"title":"List all VPN networks attached to a node, including IP assignments and routing","description":"List all VPN networks attached to a node, including IP assignments and routing"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeVpnNetworks","name":"List all VPN networks attached to a node, including IP assignments and routing","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all VPN networks attached to a node, including IP assignments and routing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/vpn","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn","href":"/appliance-greater-vpn/listnodevpnnetworks","openApiOperationId":"listNodeVpnNetworks","summary":"List all VPN networks attached to a node, including IP assignments and routing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337"}},"schemaId":"schema_337"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_337","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_337"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/listnodevpnnetworks"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn"},{"label":"Attach a VPN network","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn/post","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn/post","metadata":{"seo":{"title":"Attach a VPN network","description":"Attach a VPN network"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Attach a VPN network","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach a VPN network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"schemaId":"components/schemas/VpnNetworkUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/vpn","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn/post","summary":"Attach a VPN network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnNetworkUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnNodeNetworkInventoryModel"}},"schemaId":"components/schemas/VpnNodeNetworkInventoryModel"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VpnNodeNetworkInventoryModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnNodeNetworkInventoryModel"}}},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn"},{"label":"Delete a VPN network","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/delete","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/delete","metadata":{"seo":{"title":"Delete a VPN network","description":"Delete a VPN network"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN network","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/vpn/{networkName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/delete","summary":"Delete a VPN network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}"},{"label":"Get full details of a VPN network on a node, including routes, services, interfaces, DNS, and WireGuard config","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/getnodevpnnetwork","routeSlug":"/appliance-greater-vpn/getnodevpnnetwork","metadata":{"seo":{"title":"Get full details of a VPN network on a node, including routes, services, interfaces, DNS, and WireGuard config","description":"Get full details of a VPN network on a node, including routes, services, interfaces, DNS, and WireGuard config"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeVpnNetwork","name":"Get full details of a VPN network on a node, including routes, services, interfaces, DNS, and WireGuard config","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get full details of a VPN network on a node, including routes, services, interfaces, DNS, and WireGuard config","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/vpn/{networkName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}","href":"/appliance-greater-vpn/getnodevpnnetwork","openApiOperationId":"getNodeVpnNetwork","summary":"Get full details of a VPN network on a node, including routes, services, interfaces, DNS, and WireGuard config"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnNodeNetworkInventoryModel"}},"schemaId":"components/schemas/VpnNodeNetworkInventoryModel"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VpnNodeNetworkInventoryModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnNodeNetworkInventoryModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/getnodevpnnetwork"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}"},{"label":"Update a VPN network","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/put","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/put","metadata":{"seo":{"title":"Update a VPN network","description":"Update a VPN network"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN network","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN network","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"schemaId":"components/schemas/VpnNetworkUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/vpn/{networkName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/put","summary":"Update a VPN network"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnNetworkUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnNetworkUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}"},{"label":"Delete a VPN DNS configuration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/delete","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/delete","metadata":{"seo":{"title":"Delete a VPN DNS configuration","description":"Delete a VPN DNS configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/vpn/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dns","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/delete","summary":"Delete a VPN DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dns"},{"label":"Get a VPN's DNS configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/getnodevpndns","routeSlug":"/appliance-greater-vpn/getnodevpndns","metadata":{"seo":{"title":"Get a VPN's DNS configuration","description":"Get a VPN's DNS configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeVpnDns","name":"Get a VPN's DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a VPN's DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/vpn/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dns","href":"/appliance-greater-vpn/getnodevpndns","openApiOperationId":"getNodeVpnDns","summary":"Get a VPN's DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnNodeDnsModel"}},"schemaId":"components/schemas/VpnNodeDnsModel"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/VpnNodeDnsModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VpnNodeDnsModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/getnodevpndns"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dns"},{"label":"Create a VPN DNS configuration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/post","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/post","metadata":{"seo":{"title":"Create a VPN DNS configuration","description":"Create a VPN DNS configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"schemaId":"components/schemas/VpnDnsUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/vpn/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dns","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/post","summary":"Create a VPN DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnDnsUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dns"},{"label":"Update a VPN DNS configuration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/put","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/put","metadata":{"seo":{"title":"Update a VPN DNS configuration","description":"Update a VPN DNS configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN DNS configuration","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN DNS configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"schemaId":"components/schemas/VpnDnsUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/vpn/{networkName}/dns","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dns","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/put","summary":"Update a VPN DNS configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnDnsUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnDnsUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dns/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dns"},{"label":"Get dynamic routes exported by a node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/listnodevpnexportroutes","routeSlug":"/appliance-greater-vpn/listnodevpnexportroutes","metadata":{"seo":{"title":"Get dynamic routes exported by a node","description":"Get dynamic routes exported by a node"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeVpnExportRoutes","name":"Get dynamic routes exported by a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get dynamic routes exported by a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route","href":"/appliance-greater-vpn/listnodevpnexportroutes","openApiOperationId":"listNodeVpnExportRoutes","summary":"Get dynamic routes exported by a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}},"schemaId":"schema_338"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_338","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/listnodevpnexportroutes"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route"},{"label":"Create a VPN export route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route/post","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route/post","metadata":{"seo":{"title":"Create a VPN export route","description":"Create a VPN export route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN export route","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN export route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route/post","summary":"Create a VPN export route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route"},{"label":"Delete a VPN export route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete","metadata":{"seo":{"title":"Delete a VPN export route","description":"Delete a VPN export route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN export route","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN export route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route/{uid}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete","summary":"Delete a VPN export route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route/{uid}"},{"label":"Update a VPN export route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put","metadata":{"seo":{"title":"Update a VPN export route","description":"Update a VPN export route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN export route","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN export route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route/{uid}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put","summary":"Update a VPN export route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1export-route~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route/{uid}"},{"label":"Get dynamic routes imported by a node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/listnodevpnimportroutes","routeSlug":"/appliance-greater-vpn/listnodevpnimportroutes","metadata":{"seo":{"title":"Get dynamic routes imported by a node","description":"Get dynamic routes imported by a node"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeVpnImportRoutes","name":"Get dynamic routes imported by a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get dynamic routes imported by a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route","href":"/appliance-greater-vpn/listnodevpnimportroutes","openApiOperationId":"listNodeVpnImportRoutes","summary":"Get dynamic routes imported by a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}},"schemaId":"schema_338"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_338","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/listnodevpnimportroutes"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route"},{"label":"Create a VPN import route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route/post","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route/post","metadata":{"seo":{"title":"Create a VPN import route","description":"Create a VPN import route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN import route","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN import route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route/post","summary":"Create a VPN import route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route"},{"label":"Delete a VPN import route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete","metadata":{"seo":{"title":"Delete a VPN import route","description":"Delete a VPN import route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN import route","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN import route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route/{uid}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete","summary":"Delete a VPN import route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route/{uid}"},{"label":"Update a VPN import route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put","metadata":{"seo":{"title":"Update a VPN import route","description":"Update a VPN import route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN import route","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN import route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route/{uid}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put","summary":"Update a VPN import route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1dynamic~1import-route~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route/{uid}"},{"label":"Get a VPN's interfaces","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/listnodevpninterfaces","routeSlug":"/appliance-greater-vpn/listnodevpninterfaces","metadata":{"seo":{"title":"Get a VPN's interfaces","description":"Get the list of interfaces attached to a VPN network on a node. Note: NATs within a VPN interface can share the same source and destination CIDRs provided they are differentiated by route metric. This is intentional and not a configuration error."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeVpnInterfaces","name":"Get a VPN's interfaces","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a VPN's interfaces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the list of interfaces attached to a VPN network on a node. Note: NATs within a VPN interface can share the same source and destination CIDRs provided they are differentiated by route metric. This is intentional and not a configuration error."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/vpn/{networkName}/interface","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/interface","href":"/appliance-greater-vpn/listnodevpninterfaces","openApiOperationId":"listNodeVpnInterfaces","summary":"Get a VPN's interfaces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}},"schemaId":"schema_339"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_339","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_339"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/listnodevpninterfaces"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/interface"},{"label":"Create a VPN interface","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface/post","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface/post","metadata":{"seo":{"title":"Create a VPN interface","description":"inDefaultRoute and outDefaultRoute are mutually exclusive — set at most one to true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN interface","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN interface","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDefaultRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outDefaultRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mutually exclusive — set at most one to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inside NATs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insideNats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rewrite traffic arriving from the VPN before it enters the local network."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outside NATs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outsideNats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rewrite traffic leaving the local network before it enters the VPN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After creating or updating a VPN interface, push the node config for the change to take effect."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"schemaId":"components/schemas/VpnInterfaceUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/vpn/{networkName}/interface","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/interface","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface/post","summary":"Create a VPN interface"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnInterfaceUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/interface"},{"label":"Delete a VPN interface","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/delete","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/delete","metadata":{"seo":{"title":"Delete a VPN interface","description":"Delete a VPN interface"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN interface","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface~1{interfaceName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN interface","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"interfaceName","in":"path","schemaId":"schema_240","description":"Interface name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface~1{interfaceName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/vpn/{networkName}/interface/{interfaceName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"interfaceName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/interface/{interfaceName}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/delete","summary":"Delete a VPN interface"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface~1{interfaceName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/interface/{interfaceName}"},{"label":"Update a VPN interface","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/put","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/put","metadata":{"seo":{"title":"Update a VPN interface","description":"inDefaultRoute and outDefaultRoute are mutually exclusive — set at most one to true."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN interface","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface~1{interfaceName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN interface","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inDefaultRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outDefaultRoute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are mutually exclusive — set at most one to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inside NATs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"insideNats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rewrite traffic arriving from the VPN before it enters the local network."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outside NATs ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"outsideNats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") rewrite traffic leaving the local network before it enters the VPN."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"After creating or updating a VPN interface, push the node config for the change to take effect."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"interfaceName","in":"path","schemaId":"schema_240","description":"Interface name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface~1{interfaceName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"schemaId":"components/schemas/VpnInterfaceUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface~1{interfaceName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/vpn/{networkName}/interface/{interfaceName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"interfaceName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/interface/{interfaceName}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/put","summary":"Update a VPN interface"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnInterfaceUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnInterfaceUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1interface~1{interfaceName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/interface/{interfaceName}"},{"label":"Get local vpn routes for a node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/listnodevpnroutes","routeSlug":"/appliance-greater-vpn/listnodevpnroutes","metadata":{"seo":{"title":"Get local vpn routes for a node","description":"Get local vpn routes for a node"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeVpnRoutes","name":"Get local vpn routes for a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get local vpn routes for a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/vpn/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/route","href":"/appliance-greater-vpn/listnodevpnroutes","openApiOperationId":"listNodeVpnRoutes","summary":"Get local vpn routes for a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}},"schemaId":"schema_338"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_338","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_338"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/listnodevpnroutes"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/route"},{"label":"Create a VPN route","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route/post","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route/post","metadata":{"seo":{"title":"Create a VPN route","description":"Create a VPN route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN route","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/vpn/{networkName}/route","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/route","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route/post","summary":"Create a VPN route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/route"},{"label":"Delete a VPN route","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/delete","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/delete","metadata":{"seo":{"title":"Delete a VPN route","description":"Delete a VPN route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN route","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/vpn/{networkName}/route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/route/{uid}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/delete","summary":"Delete a VPN route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/route/{uid}"},{"label":"Update a VPN route","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/put","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/put","metadata":{"seo":{"title":"Update a VPN route","description":"Update a VPN route"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a VPN route","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a VPN route","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Route ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"schemaId":"components/schemas/VpnRouteUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/vpn/{networkName}/route/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/route/{uid}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/put","summary":"Update a VPN route"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnRouteUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnRouteUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1route~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/route/{uid}"},{"label":"Get a VPN's services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/listnodevpnservices","routeSlug":"/appliance-greater-vpn/listnodevpnservices","metadata":{"seo":{"title":"Get a VPN's services","description":"Requires node-vpn::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeVpnServices","name":"Get a VPN's services","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a VPN's services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-vpn::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/vpn/{networkName}/service","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/service","href":"/appliance-greater-vpn/listnodevpnservices","openApiOperationId":"listNodeVpnServices","summary":"Get a VPN's services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}},"schemaId":"schema_340"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_340","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_340"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/listnodevpnservices"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/service"},{"label":"Create a VPN Service","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service/post","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service/post","metadata":{"seo":{"title":"Create a VPN Service","description":"Requires node-vpn::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a VPN Service","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a VPN Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-vpn::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"schemaId":"components/schemas/VpnServiceUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/vpn/{networkName}/service","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/service","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service/post","summary":"Create a VPN Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnServiceUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/service"},{"label":"Delete a VPN Service","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/delete","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/delete","metadata":{"seo":{"title":"Delete a VPN Service","description":"Requires node-vpn::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a VPN Service","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a VPN Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-vpn::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/vpn/{networkName}/service/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/service/{uid}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/delete","summary":"Delete a VPN Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/service/{uid}"},{"label":"Update a Service","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/put","routeSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/put","metadata":{"seo":{"title":"Update a Service","description":"Update a Service"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a Service","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a Service","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"uid","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"schemaId":"components/schemas/VpnServiceUpdateModel","pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/vpn/{networkName}/service/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/vpn/{networkName}/service/{uid}","href":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/put","summary":"Update a Service"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VpnServiceUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VpnServiceUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1vpn~1{networkName}~1service~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/vpn/{networkName}/service/{uid}"}],"content":{"contentType":"group","meta":{"name":"Appliance > VPN"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"VPN","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Per-appliance attachment to virtual networks. Configure which virtual networks an appliance participates in and its VPN interface settings. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-vpn::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/node/{nodeID}/vpn","summary":"List all VPN networks attached to a node, including IP assignments and routing","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-vpn/listnodevpnnetworks","deprecated":false},{"title":"/v2/node/{nodeID}/vpn","summary":"Attach a VPN network","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn/post","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}","summary":"Delete a VPN network","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/delete","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}","summary":"Get full details of a VPN network on a node, including routes, services, interfaces, DNS, and WireGuard config","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-vpn/getnodevpnnetwork","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}","summary":"Update a VPN network","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}/put","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dns","summary":"Delete a VPN DNS configuration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/delete","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dns","summary":"Get a VPN's DNS configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-vpn/getnodevpndns","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dns","summary":"Create a VPN DNS configuration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/post","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dns","summary":"Update a VPN DNS configuration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dns/put","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route","summary":"Get dynamic routes exported by a node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-vpn/listnodevpnexportroutes","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route","summary":"Create a VPN export route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route/post","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route/{uid}","summary":"Delete a VPN export route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/delete","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/export-route/{uid}","summary":"Update a VPN export route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1export-route~1{uid}/put","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route","summary":"Get dynamic routes imported by a node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-vpn/listnodevpnimportroutes","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route","summary":"Create a VPN import route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route/post","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route/{uid}","summary":"Delete a VPN import route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/delete","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/dynamic/import-route/{uid}","summary":"Update a VPN import route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1dynamic~1import-route~1{uid}/put","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/interface","summary":"Get a VPN's interfaces","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-vpn/listnodevpninterfaces","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/interface","summary":"Create a VPN interface","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface/post","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/interface/{interfaceName}","summary":"Delete a VPN interface","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/delete","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/interface/{interfaceName}","summary":"Update a VPN interface","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1interface~1{interfacename}/put","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/route","summary":"Get local vpn routes for a node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-vpn/listnodevpnroutes","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/route","summary":"Create a VPN route","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route/post","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/route/{uid}","summary":"Delete a VPN route","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/delete","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/route/{uid}","summary":"Update a VPN route","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1route~1{uid}/put","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/service","summary":"Get a VPN's services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-vpn/listnodevpnservices","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/service","summary":"Create a VPN Service","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service/post","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/service/{uid}","summary":"Delete a VPN Service","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/delete","deprecated":false},{"title":"/v2/node/{nodeID}/vpn/{networkName}/service/{uid}","summary":"Update a Service","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance-greater-vpn/paths/~1v2~1node~1{nodeid}~1vpn~1{networkname}~1service~1{uid}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Compute","link":"/appliance-greater-compute","routeSlug":"/appliance-greater-compute","items":[{"label":"List containers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/listnodecontainers","routeSlug":"/appliance-greater-compute/listnodecontainers","metadata":{"seo":{"title":"List containers","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeContainers","name":"List containers","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List containers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container","href":"/appliance-greater-compute/listnodecontainers","openApiOperationId":"listNodeContainers","summary":"List containers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273"}},"schemaId":"schema_273"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_273","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_273"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/listnodecontainers"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container"},{"label":"Create a container","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container/post","routeSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container/post","metadata":{"seo":{"title":"Create a container","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a container","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a container","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Container"}},"schemaId":"components/schemas/Container","pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container/post/requestBody","description":"Container"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/exec/container","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Container"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/exec/container","href":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container/post","summary":"Create a container"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Container","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Container"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container"},{"label":"Delete a container","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/delete","routeSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/delete","metadata":{"seo":{"title":"Delete a container","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a container","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a container","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/exec/container/{containerID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}","href":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/delete","summary":"Delete a container"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}"},{"label":"Get edge compute container configuration on a node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/getnodecontainer","routeSlug":"/appliance-greater-compute/getnodecontainer","metadata":{"seo":{"title":"Get edge compute container configuration on a node","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeContainer","name":"Get edge compute container configuration on a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get edge compute container configuration on a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}","href":"/appliance-greater-compute/getnodecontainer","openApiOperationId":"getNodeContainer","summary":"Get edge compute container configuration on a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Container"}},"schemaId":"components/schemas/Container"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Container","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Container"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/getnodecontainer"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}"},{"label":"Update a container","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/put","routeSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/put","metadata":{"seo":{"title":"Update a container","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a container","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a container","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Container"}},"schemaId":"components/schemas/Container","pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/put/requestBody","description":"Container"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/exec/container/{containerID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Container"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}","href":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/put","summary":"Update a container"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Container","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Container"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}"},{"label":"Get container capabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/getnodecontainercapabilities","routeSlug":"/appliance-greater-compute/getnodecontainercapabilities","metadata":{"seo":{"title":"Get container capabilities","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeContainerCapabilities","name":"Get container capabilities","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1capability/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get container capabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1capability/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/capability","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/capability","href":"/appliance-greater-compute/getnodecontainercapabilities","openApiOperationId":"getNodeContainerCapabilities","summary":"Get container capabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerCapabilities"}},"schemaId":"components/schemas/ContainerCapabilities"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1capability/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerCapabilities","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerCapabilities"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/getnodecontainercapabilities"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/capability"},{"label":"Update container config","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}~1config/put","routeSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}~1config/put","metadata":{"seo":{"title":"Update container config","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update container config","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1config/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update container config","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1config/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContainerConfig"}},"schemaId":"components/schemas/ContainerConfig","pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1config/put/requestBody","description":"Container config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/exec/container/{containerID}/config","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ContainerConfig"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/config","href":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}~1config/put","summary":"Update container config"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ContainerConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ContainerConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1config/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}~1config/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/config"},{"label":"Get container health check","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/getnodecontainerhealthcheck","routeSlug":"/appliance-greater-compute/getnodecontainerhealthcheck","metadata":{"seo":{"title":"Get container health check","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeContainerHealthCheck","name":"Get container health check","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1healthcheck/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get container health check","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1healthcheck/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/healthcheck","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/healthcheck","href":"/appliance-greater-compute/getnodecontainerhealthcheck","openApiOperationId":"getNodeContainerHealthCheck","summary":"Get container health check"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerHealthCheck"}},"schemaId":"components/schemas/ContainerHealthCheck"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1healthcheck/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerHealthCheck","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerHealthCheck"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/getnodecontainerhealthcheck"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/healthcheck"},{"label":"List container interfaces","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/listnodecontainerinterfaces","routeSlug":"/appliance-greater-compute/listnodecontainerinterfaces","metadata":{"seo":{"title":"List container interfaces","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeContainerInterfaces","name":"List container interfaces","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1interface/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container interfaces","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1interface/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/interface","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/interface","href":"/appliance-greater-compute/listnodecontainerinterfaces","openApiOperationId":"listNodeContainerInterfaces","summary":"List container interfaces"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_274"}},"schemaId":"schema_274"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1interface/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_274","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_274"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/listnodecontainerinterfaces"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/interface"},{"label":"List container limits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/listnodecontainerlimits","routeSlug":"/appliance-greater-compute/listnodecontainerlimits","metadata":{"seo":{"title":"List container limits","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeContainerLimits","name":"List container limits","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1limit/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container limits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1limit/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/limit","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/limit","href":"/appliance-greater-compute/listnodecontainerlimits","openApiOperationId":"listNodeContainerLimits","summary":"List container limits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerLimits"}},"schemaId":"components/schemas/ContainerLimits"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1limit/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerLimits","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerLimits"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/listnodecontainerlimits"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/limit"},{"label":"Get container logging configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/getnodecontainerlogging","routeSlug":"/appliance-greater-compute/getnodecontainerlogging","metadata":{"seo":{"title":"Get container logging configuration","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeContainerLogging","name":"Get container logging configuration","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1logging/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get container logging configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1logging/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/logging","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/logging","href":"/appliance-greater-compute/getnodecontainerlogging","openApiOperationId":"getNodeContainerLogging","summary":"Get container logging configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerLogging"}},"schemaId":"components/schemas/ContainerLogging"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1logging/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerLogging","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerLogging"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/getnodecontainerlogging"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/logging"},{"label":"List container mounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/listnodecontainermounts","routeSlug":"/appliance-greater-compute/listnodecontainermounts","metadata":{"seo":{"title":"List container mounts","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeContainerMounts","name":"List container mounts","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1mount/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container mounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1mount/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/mount","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/mount","href":"/appliance-greater-compute/listnodecontainermounts","openApiOperationId":"listNodeContainerMounts","summary":"List container mounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}},"schemaId":"schema_275"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1mount/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_275","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_275"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/listnodecontainermounts"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/mount"},{"label":"List container port mappings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/listnodecontainerportmappings","routeSlug":"/appliance-greater-compute/listnodecontainerportmappings","metadata":{"seo":{"title":"List container port mappings","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeContainerPortMappings","name":"List container port mappings","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1port-mapping/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container port mappings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1port-mapping/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/port-mapping","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/port-mapping","href":"/appliance-greater-compute/listnodecontainerportmappings","openApiOperationId":"listNodeContainerPortMappings","summary":"List container port mappings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276"}},"schemaId":"schema_276"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1port-mapping/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_276","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_276"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/listnodecontainerportmappings"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/port-mapping"},{"label":"List container variables","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/listnodecontainervariables","routeSlug":"/appliance-greater-compute/listnodecontainervariables","metadata":{"seo":{"title":"List container variables","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeContainerVariables","name":"List container variables","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1variable/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container variables","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1variable/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/variable","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/variable","href":"/appliance-greater-compute/listnodecontainervariables","openApiOperationId":"listNodeContainerVariables","summary":"List container variables"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277"}},"schemaId":"schema_277"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1variable/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_277","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_277"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/listnodecontainervariables"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/variable"},{"label":"List container virtual networks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/listnodecontainervirtualnetworks","routeSlug":"/appliance-greater-compute/listnodecontainervirtualnetworks","metadata":{"seo":{"title":"List container virtual networks","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeContainerVirtualNetworks","name":"List container virtual networks","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1virtual-network/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container virtual networks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1virtual-network/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/virtual-network","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/virtual-network","href":"/appliance-greater-compute/listnodecontainervirtualnetworks","openApiOperationId":"listNodeContainerVirtualNetworks","summary":"List container virtual networks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278"}},"schemaId":"schema_278"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1virtual-network/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_278","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_278"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/listnodecontainervirtualnetworks"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/virtual-network"},{"label":"List container volumes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/listnodecontainervolumes","routeSlug":"/appliance-greater-compute/listnodecontainervolumes","metadata":{"seo":{"title":"List container volumes","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeContainerVolumes","name":"List container volumes","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1volume/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List container volumes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1volume/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/volume","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/volume","href":"/appliance-greater-compute/listnodecontainervolumes","openApiOperationId":"listNodeContainerVolumes","summary":"List container volumes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}},"schemaId":"schema_279"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1volume/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_279","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/listnodecontainervolumes"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/volume"},{"label":"Get container VRF","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/getnodecontainervrf","routeSlug":"/appliance-greater-compute/getnodecontainervrf","metadata":{"seo":{"title":"Get container VRF","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeContainerVrf","name":"Get container VRF","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1vrf/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get container VRF","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"containerID","in":"path","schemaId":"schema_240","description":"Container ID","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1vrf/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/container/{containerID}/vrf","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"containerID","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/container/{containerID}/vrf","href":"/appliance-greater-compute/getnodecontainervrf","openApiOperationId":"getNodeContainerVrf","summary":"Get container VRF"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerVRF"}},"schemaId":"components/schemas/ContainerVRF"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1container~1{containerID}~1vrf/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ContainerVRF","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ContainerVRF"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/getnodecontainervrf"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/container/{containerID}/vrf"},{"label":"List volumes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/listnodevolumes","routeSlug":"/appliance-greater-compute/listnodevolumes","metadata":{"seo":{"title":"List volumes","description":"Requires node-exec::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeVolumes","name":"List volumes","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List volumes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/node/{nodeID}/exec/volume","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/volume","href":"/appliance-greater-compute/listnodevolumes","openApiOperationId":"listNodeVolumes","summary":"List volumes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}},"schemaId":"schema_279"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_279","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_279"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/listnodevolumes"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/volume"},{"label":"Create volume","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume/post","routeSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume/post","metadata":{"seo":{"title":"Create volume","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create volume","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create volume","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Volume"}},"schemaId":"components/schemas/Volume","pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume/post/requestBody","description":"Volume"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/exec/volume","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Volume"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/exec/volume","href":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume/post","summary":"Create volume"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Volume","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Volume"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/volume"},{"label":"Delete a volume","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume~1{volumename}/delete","routeSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume~1{volumename}/delete","metadata":{"seo":{"title":"Delete a volume","description":"Requires node-exec::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a volume","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume~1{volumeName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a volume","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"volumeName","in":"path","schemaId":"schema_240","description":"Volume Name","required":true},{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume~1{volumeName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/exec/volume/{volumeName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"volumeName","in":"path","required":true,"schemaId":"schema_240"},{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/exec/volume/{volumeName}","href":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume~1{volumename}/delete","summary":"Delete a volume"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1exec~1volume~1{volumeName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume~1{volumename}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/exec/volume/{volumeName}"}],"content":{"contentType":"group","meta":{"name":"Appliance > Compute"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Compute","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/nodes/appliances/containers/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Appliance edge compute"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — Docker container workloads deployed on a specific appliance. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-exec::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exec"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature flag."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/node/{nodeID}/exec/container","summary":"List containers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/listnodecontainers","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container","summary":"Create a container","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container/post","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}","summary":"Delete a container","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/delete","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}","summary":"Get edge compute container configuration on a node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/getnodecontainer","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}","summary":"Update a container","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}/put","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/capability","summary":"Get container capabilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/getnodecontainercapabilities","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/config","summary":"Update container config","prefix":{"name":"put","color":"put"},"badges":[],"link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1container~1{containerid}~1config/put","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/healthcheck","summary":"Get container health check","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/getnodecontainerhealthcheck","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/interface","summary":"List container interfaces","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/listnodecontainerinterfaces","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/limit","summary":"List container limits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/listnodecontainerlimits","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/logging","summary":"Get container logging configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/getnodecontainerlogging","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/mount","summary":"List container mounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/listnodecontainermounts","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/port-mapping","summary":"List container port mappings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/listnodecontainerportmappings","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/variable","summary":"List container variables","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/listnodecontainervariables","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/virtual-network","summary":"List container virtual networks","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/listnodecontainervirtualnetworks","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/volume","summary":"List container volumes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/listnodecontainervolumes","deprecated":false},{"title":"/v2/node/{nodeID}/exec/container/{containerID}/vrf","summary":"Get container VRF","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/getnodecontainervrf","deprecated":false},{"title":"/v2/node/{nodeID}/exec/volume","summary":"List volumes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/appliance-greater-compute/listnodevolumes","deprecated":false},{"title":"/v2/node/{nodeID}/exec/volume","summary":"Create volume","prefix":{"name":"post","color":"post"},"badges":[],"link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume/post","deprecated":false},{"title":"/v2/node/{nodeID}/exec/volume/{volumeName}","summary":"Delete a volume","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/appliance-greater-compute/paths/~1v2~1node~1{nodeid}~1exec~1volume~1{volumename}/delete","deprecated":false}]}]}]}]}},{"type":"separator","label":"Agent","content":null},{"type":"group","label":"Agent","link":"/agent","routeSlug":"/agent","items":[{"label":"Retrieve all network nodes including appliances and agents with filtering options","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/listnodes","routeSlug":"/agent/listnodes","metadata":{"seo":{"title":"Retrieve all network nodes including appliances and agents with filtering options","description":"List both appliances and agents. The fields config and shadow will be empty unlessspecified in the projection parameter. The query for the config or shadow must be at leastone level deep - projection[0][0]=config won't work, but projection[0][0]=config&projection[0][1]=gatewaywill result in config.gateway being populated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodes","name":"Retrieve all network nodes including appliances and agents with filtering options","isWebhook":false,"pointer":"/paths/~1node/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all network nodes including appliances and agents with filtering options","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List both appliances and agents. The fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shadow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" will be empty unless"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter. The query for the config or shadow must be at least"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"one level deep - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[0][0]=config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" won't work, but "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[0][0]=config&projection[0][1]=gateway"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"will result in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.gateway"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being populated."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"cluster","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When provided, limit the nodes to members of the cluster. Should be the full cluster FQDN, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mycluster.trustgrid.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"tags","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated key:value pairs for tag filtering, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location:Austin,device:Trustgrid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"projection[]","in":"query","schemaId":"schema_280","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reduces the response to a smaller set of fields. When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"omitted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all fields are returned ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fqdn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cluster"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_connect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"heartbeat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lifecycleState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnectTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", plus base fields)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specified"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the response contains only a fixed base set plus each explicitly requested field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base set"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (always present when any projection is specified): "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgTags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keys"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Top-level requestable fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fqdn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"online"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cluster"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last_connect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created_at"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"device"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"heartbeat"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lifecycleState"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"disconnectTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderID"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IMPORTANT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shadow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be used as flat projection keys (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[]=shadow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[]=config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are rejected as too large). To retrieve data from these objects, you must use nested indexed projection (see below)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"WARNING"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Dot-notation strings do NOT work. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[]=config.gateway.enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" silently returns an empty "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config: {}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object. Do not use dot notation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Nested projection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" uses indexed bracket notation where each projection entry has an outer index N and each path segment has an inner index M. To request "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config.gateway.enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as entry 0 and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"shadow.reported[\"node-core.version\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as entry 1:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection[0][0]=config&projection[0][1]=gateway&projection[0][2]=enabled&projection[1][0]=shadow&projection[1][1]=reported&projection[1][2]=node-core.version"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If using curl, use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-g"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flag to prevent brace expansion."},"children":[]}]}]}]}],"pointer":"/paths/~1node/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/node","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"cluster","in":"query","schemaId":"schema_240"},{"name":"tags","in":"query","schemaId":"schema_240"},{"name":"projection[]","in":"query","schemaId":"schema_280","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node","href":"/agent/listnodes","openApiOperationId":"listNodes","summary":"Retrieve all network nodes including appliances and agents with filtering options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281"}},"schemaId":"schema_281"}],"pointer":"/paths/~1node/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_281","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_281"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/listnodes"}],"panels":[]}]},"httpPath":"/node"},{"label":"Retrieve a node by its fully-qualified domain name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/getnodebyfqdn","routeSlug":"/agent/getnodebyfqdn","metadata":{"seo":{"title":"Retrieve a node by its fully-qualified domain name","description":"Get a node using its FQDN directly, as an alternative to looking up the nodeID first."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeByFQDN","name":"Retrieve a node by its fully-qualified domain name","isWebhook":false,"pointer":"/paths/~1node~1by-fqdn~1{fqdn}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a node by its fully-qualified domain name","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a node using its FQDN directly, as an alternative to looking up the nodeID first."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission on the node."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fqdn","in":"path","schemaId":"schema_240","description":"Node FQDN (e.g., appliance.example.trustgrid.io)","required":true}],"pointer":"/paths/~1node~1by-fqdn~1{fqdn}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/node/by-fqdn/{fqdn}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"fqdn","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/node/by-fqdn/{fqdn}","href":"/agent/getnodebyfqdn","openApiOperationId":"getNodeByFQDN","summary":"Retrieve a node by its fully-qualified domain name"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Node"}},"schemaId":"components/schemas/Node"},{"code":"404","description":"Node not found or permission denied"}],"pointer":"/paths/~1node~1by-fqdn~1{fqdn}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Node","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Node"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/getnodebyfqdn"}],"panels":[]}]},"httpPath":"/node/by-fqdn/{fqdn}"},{"label":"Permanently remove a node from the organization and revoke access","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}/delete","routeSlug":"/agent/paths/~1node~1{nodeid}/delete","metadata":{"seo":{"title":"Permanently remove a node from the organization and revoke access","description":"Delete a node (appliance or agent)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Permanently remove a node from the organization and revoke access","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permanently remove a node from the organization and revoke access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a node (appliance or agent)"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/node/{nodeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/node/{nodeID}","href":"/agent/paths/~1node~1{nodeid}/delete","summary":"Permanently remove a node from the organization and revoke access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1node~1{nodeID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}/delete"}],"panels":[]}]},"httpPath":"/node/{nodeID}"},{"label":"Retrieve detailed configuration and status information for a specific node","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/getnode","routeSlug":"/agent/getnode","metadata":{"seo":{"title":"Retrieve detailed configuration and status information for a specific node","description":"Get a node (appliance or agent)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNode","name":"Retrieve detailed configuration and status information for a specific node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed configuration and status information for a specific node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a node (appliance or agent)"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/node/{nodeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/node/{nodeID}","href":"/agent/getnode","openApiOperationId":"getNode","summary":"Retrieve detailed configuration and status information for a specific node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Node"}},"schemaId":"components/schemas/Node"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1node~1{nodeID}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Node","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Node"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/getnode"}],"panels":[]}]},"httpPath":"/node/{nodeID}"},{"label":"Modify node settings including cluster assignment and operational state","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}/put","routeSlug":"/agent/paths/~1node~1{nodeid}/put","metadata":{"seo":{"title":"Modify node settings including cluster assignment and operational state","description":"Update a node (appliance or agent)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify node settings including cluster assignment and operational state","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify node settings including cluster assignment and operational state","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a node (appliance or agent)"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_282"}},"schemaId":"schema_282","pointer":"/paths/~1node~1{nodeID}/put/requestBody","description":"Node updates"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_282"}},"responseCodes":["200"],"pointer":"/node/{nodeID}","href":"/agent/paths/~1node~1{nodeid}/put","summary":"Modify node settings including cluster assignment and operational state"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_282","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_282"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}"},{"label":"Configure inbound network connectors for external access to node services","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}~1config~1connectors/put","routeSlug":"/agent/paths/~1node~1{nodeid}~1config~1connectors/put","metadata":{"seo":{"title":"Configure inbound network connectors for external access to node services","description":"Configure inbound network connectors for external access to node services"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure inbound network connectors for external access to node services","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure inbound network connectors for external access to node services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectorConfig"}},"schemaId":"components/schemas/ConnectorConfig","pointer":"/paths/~1node~1{nodeID}~1config~1connectors/put/requestBody","description":"Config body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/connectors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ConnectorConfig"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/config/connectors","href":"/agent/paths/~1node~1{nodeid}~1config~1connectors/put","summary":"Configure inbound network connectors for external access to node services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ConnectorConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ConnectorConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}~1config~1connectors/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/connectors"},{"label":"Remove all connector configurations from a node","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}~1config~1connectors/delete","routeSlug":"/agent/paths/~1node~1{nodeid}~1config~1connectors/delete","metadata":{"seo":{"title":"Remove all connector configurations from a node","description":"Remove all connector configurations from a node"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove all connector configurations from a node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove all connector configurations from a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/node/{nodeID}/config/connectors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node/{nodeID}/config/connectors","href":"/agent/paths/~1node~1{nodeid}~1config~1connectors/delete","summary":"Remove all connector configurations from a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1connectors/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}~1config~1connectors/delete"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/connectors"},{"label":"Create a new inbound connector to expose services running on the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors/post","routeSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors/post","metadata":{"seo":{"title":"Create a new inbound connector to expose services running on the node","description":"Requires node::configure::connectors permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new inbound connector to expose services running on the node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new inbound connector to expose services running on the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"schemaId":"components/schemas/EdgeConnector","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors/post/requestBody","description":"Connector"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/connectors","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/connectors","href":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors/post","summary":"Create a new inbound connector to expose services running on the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeConnector","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/connectors"},{"label":"Migrate a node's connector configuration to the latest V2 format","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post","routeSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post","metadata":{"seo":{"title":"Migrate a node's connector configuration to the latest V2 format","description":"Requires node::configure::connectors permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Migrate a node's connector configuration to the latest V2 format","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1upgrade/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate a node's connector configuration to the latest V2 format","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1upgrade/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/connectors/upgrade","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/connectors/upgrade","href":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post","summary":"Migrate a node's connector configuration to the latest V2 format"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1upgrade/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/connectors/upgrade"},{"label":"Modify settings for an existing connector on a node","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put","routeSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put","metadata":{"seo":{"title":"Modify settings for an existing connector on a node","description":"Applies to appliances and agents. Requires V2 connector config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify settings for an existing connector on a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify settings for an existing connector on a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applies to appliances and agents. Requires V2 connector config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"connectorID","in":"path","schemaId":"schema_240","description":"Connector ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"schemaId":"components/schemas/EdgeConnector","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/put/requestBody","description":"Connector"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/connectors/{connectorID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"connectorID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/connectors/{connectorID}","href":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put","summary":"Modify settings for an existing connector on a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeConnector","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeConnector"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/connectors/{connectorID}"},{"label":"Remove a specific connector configuration from a node","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete","routeSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete","metadata":{"seo":{"title":"Remove a specific connector configuration from a node","description":"Delete a connector from a node (appliance or agent). Requires V2 connector config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a specific connector configuration from a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a specific connector configuration from a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a connector from a node (appliance or agent). Requires V2 connector config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"connectorID","in":"path","schemaId":"schema_240","description":"Connector ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/connectors/{connectorID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"connectorID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/connectors/{connectorID}","href":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete","summary":"Remove a specific connector configuration from a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1connectors~1{connectorID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/connectors/{connectorID}"},{"label":"Configure outbound services for external connections from the node","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}~1config~1services/put","routeSlug":"/agent/paths/~1node~1{nodeid}~1config~1services/put","metadata":{"seo":{"title":"Configure outbound services for external connections from the node","description":"Update services configuration for a node (appliance or agent)"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure outbound services for external connections from the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1services/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure outbound services for external connections from the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update services configuration for a node (appliance or agent)\n\n---\n\nNote: request body will be validated by JSON schema of the plugin\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1services/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceConfig"}},"schemaId":"components/schemas/ServiceConfig","pointer":"/paths/~1node~1{nodeID}~1config~1services/put/requestBody","description":"Config body"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/services","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ServiceConfig"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/config/services","href":"/agent/paths/~1node~1{nodeid}~1config~1services/put","summary":"Configure outbound services for external connections from the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ServiceConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ServiceConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1config~1services/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}~1config~1services/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/services"},{"label":"Create a new outbound service connection for external resource access","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services/post","routeSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services/post","metadata":{"seo":{"title":"Create a new outbound service connection for external resource access","description":"Requires node::configure::services permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new outbound service connection for external resource access","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new outbound service connection for external resource access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"schemaId":"components/schemas/EdgeService","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services/post/requestBody","description":"Service"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/services","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/services","href":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services/post","summary":"Create a new outbound service connection for external resource access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeService","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/services"},{"label":"Migrate a node's service configuration to the latest V2 format","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post","routeSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post","metadata":{"seo":{"title":"Migrate a node's service configuration to the latest V2 format","description":"Requires node::configure::services permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Migrate a node's service configuration to the latest V2 format","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1upgrade/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Migrate a node's service configuration to the latest V2 format","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1upgrade/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/node/{nodeID}/config/services/upgrade","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/services/upgrade","href":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post","summary":"Migrate a node's service configuration to the latest V2 format"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1upgrade/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/services/upgrade"},{"label":"Modify settings for an existing service connection on a node","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put","routeSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put","metadata":{"seo":{"title":"Modify settings for an existing service connection on a node","description":"Update a service on a node. Requires V2 services config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify settings for an existing service connection on a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify settings for an existing service connection on a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a service on a node. Requires V2 services config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"serviceID","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"schemaId":"components/schemas/EdgeService","pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/put/requestBody","description":"Service"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/config/services/{serviceID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"serviceID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"responseCodes":["200","422"],"pointer":"/v2/node/{nodeID}/config/services/{serviceID}","href":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put","summary":"Modify settings for an existing service connection on a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/EdgeService","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/EdgeService"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/services/{serviceID}"},{"label":"Remove a specific service configuration from a node","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete","routeSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete","metadata":{"seo":{"title":"Remove a specific service configuration from a node","description":"Delete a service from a node. Requires V2 services config."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a specific service configuration from a node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a specific service configuration from a node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delete a service from a node. Requires V2 services config."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node::configure::services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"serviceID","in":"path","schemaId":"schema_240","description":"Service ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/node/{nodeID}/config/services/{serviceID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"serviceID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/node/{nodeID}/config/services/{serviceID}","href":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete","summary":"Remove a specific service configuration from a node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1config~1services~1{serviceID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/config/services/{serviceID}"},{"label":"Configure node as a network gateway for routing traffic between networks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}~1config~1gateway/put","routeSlug":"/agent/paths/~1node~1{nodeid}~1config~1gateway/put","metadata":{"seo":{"title":"Configure node as a network gateway for routing traffic between networks","description":"Update gateway configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure node as a network gateway for routing traffic between networks","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1config~1gateway/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure node as a network gateway for routing traffic between networks","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update gateway configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"host"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ip"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for the gateway hostname."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:gateway"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1config~1gateway/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_286"}},"schemaId":"schema_286","pointer":"/paths/~1node~1{nodeID}~1config~1gateway/put/requestBody","description":"Gateway config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/config/gateway","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_286"}},"responseCodes":["200","422"],"pointer":"/node/{nodeID}/config/gateway","href":"/agent/paths/~1node~1{nodeid}~1config~1gateway/put","summary":"Configure node as a network gateway for routing traffic between networks"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_286","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_286"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1node~1{nodeID}~1config~1gateway/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}~1config~1gateway/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/config/gateway"},{"label":"Configure SNMP monitoring settings for network management integration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}~1snmp/put","routeSlug":"/agent/paths/~1node~1{nodeid}~1snmp/put","metadata":{"seo":{"title":"Configure SNMP monitoring settings for network management integration","description":"Update SNMP configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure SNMP monitoring settings for network management integration","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1snmp/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure SNMP monitoring settings for network management integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update SNMP configuration"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:snmp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1snmp/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_287"}},"schemaId":"schema_287","pointer":"/paths/~1node~1{nodeID}~1snmp/put/requestBody","description":"SNMP config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/snmp","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_287"}},"responseCodes":["200","422"],"pointer":"/node/{nodeID}/snmp","href":"/agent/paths/~1node~1{nodeid}~1snmp/put","summary":"Configure SNMP monitoring settings for network management integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_287","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_287"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1node~1{nodeID}~1snmp/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}~1snmp/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/snmp"},{"label":"Remove a metadata tag from a node for organizational categorization","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/delete","routeSlug":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/delete","metadata":{"seo":{"title":"Remove a metadata tag from a node for organizational categorization","description":"Remove a metadata tag from a node for organizational categorization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a metadata tag from a node for organizational categorization","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a metadata tag from a node for organizational categorization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"tagName","in":"path","schemaId":"schema_240","description":"Tag name","required":true}],"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/node/{nodeID}/tag/{tagName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"tagName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/node/{nodeID}/tag/{tagName}","href":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/delete","summary":"Remove a metadata tag from a node for organizational categorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/delete"}],"panels":[]}]},"httpPath":"/node/{nodeID}/tag/{tagName}"},{"label":"Add or update a metadata tag on a node for organizational categorization","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/put","routeSlug":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/put","metadata":{"seo":{"title":"Add or update a metadata tag on a node for organizational categorization","description":"Add or update a metadata tag on a node for organizational categorization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add or update a metadata tag on a node for organizational categorization","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add or update a metadata tag on a node for organizational categorization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"tagName","in":"path","schemaId":"schema_240","description":"Tag name","required":true}],"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagValueModel"}},"schemaId":"components/schemas/TagValueModel","pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/node/{nodeID}/tag/{tagName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"tagName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/TagValueModel"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/tag/{tagName}","href":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/put","summary":"Add or update a metadata tag on a node for organizational categorization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/TagValueModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/TagValueModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1node~1{nodeID}~1tag~1{tagName}/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/put"}],"panels":[]}]},"httpPath":"/node/{nodeID}/tag/{tagName}"},{"label":"Run a throughput performance test to a peer gateway node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/triggernodegatewayperf","routeSlug":"/agent/triggernodegatewayperf","metadata":{"seo":{"title":"Run a throughput performance test to a peer gateway node","description":"Opens a streaming session that sends a configurable amount of data to thedestination node and measures throughput. Progress is streamed as text whilethe test runs; a summary line with rate in Mbps is emitted at the end."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeGatewayPerf","name":"Run a throughput performance test to a peer gateway node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run a throughput performance test to a peer gateway node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opens a streaming session that sends a configurable amount of data to the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"destination node and measures throughput. Progress is streamed as text while"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the test runs; a summary line with rate in Mbps is emitted at the end."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the test completes and receive the full output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:gateway-perf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_295"}},"schemaId":"schema_295","pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/gateway-perf","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_295"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/gateway-perf","href":"/agent/triggernodegatewayperf","openApiOperationId":"triggerNodeGatewayPerf","summary":"Run a throughput performance test to a peer gateway node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_295","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_295"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-perf/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/triggernodegatewayperf"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/gateway-perf"},{"label":"Ping a peer gateway node over the Trustgrid overlay","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/triggernodegatewayping","routeSlug":"/agent/triggernodegatewayping","metadata":{"seo":{"title":"Ping a peer gateway node over the Trustgrid overlay","description":"Sends echo packets to the specified destination node through the Trustgridgateway overlay and reports round-trip latency. Results stream as JSON objectswith RTT measurements."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeGatewayPing","name":"Ping a peer gateway node over the Trustgrid overlay","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Ping a peer gateway node over the Trustgrid overlay","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends echo packets to the specified destination node through the Trustgrid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"gateway overlay and reports round-trip latency. Results stream as JSON objects"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with RTT measurements."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the session ends and receive buffered output."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:gateway-ping"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_296"}},"schemaId":"schema_296","pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/gateway-ping","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_296"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/gateway-ping","href":"/agent/triggernodegatewayping","openApiOperationId":"triggerNodeGatewayPing","summary":"Ping a peer gateway node over the Trustgrid overlay"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_296","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_296"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1gateway-ping/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/triggernodegatewayping"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/gateway-ping"},{"label":"Stream plugin debug messages from the node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/triggernodedebug","routeSlug":"/agent/triggernodedebug","metadata":{"seo":{"title":"Stream plugin debug messages from the node","description":"Opens a streaming session that subscribes to internal plugin debug messages.Optionally filter by plugin name. Messages arrive formatted asHH:MM:SS.mmm: {message} lines."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"triggerNodeDebug","name":"Stream plugin debug messages from the node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Stream plugin debug messages from the node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opens a streaming session that subscribes to internal plugin debug messages."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally filter by plugin name. Messages arrive formatted as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"HH:MM:SS.mmm: {message}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" lines."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to buffer messages until the session ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:node-debug"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_300"}},"schemaId":"schema_300","pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/node-debug","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_300"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/node-debug","href":"/agent/triggernodedebug","openApiOperationId":"triggerNodeDebug","summary":"Stream plugin debug messages from the node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_300","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_300"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}},"schemaId":"schema_266"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1node-debug/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_266","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_266"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/triggernodedebug"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/node-debug"},{"label":"Execute a remote operation or command on a specific node","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1node~1{nodeid}~1trigger~1{event}/post","routeSlug":"/agent/paths/~1node~1{nodeid}~1trigger~1{event}/post","metadata":{"seo":{"title":"Execute a remote operation or command on a specific node","description":"Sends an event to the node and optionally waits for its response. Use thededicated event endpoints (e.g. /node/{nodeID}/trigger/gateway-routes) fordocumented events with typed request and response schemas."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Execute a remote operation or command on a specific node","isWebhook":false,"pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute a remote operation or command on a specific node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sends an event to the node and optionally waits for its response. Use the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dedicated event endpoints (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/node/{nodeID}/trigger/gateway-routes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documented events with typed request and response schemas."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event=bgp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the backend currently supports:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action: get"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — return BGP runtime status, peer sessions, learned routes,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejected routes, and advertised prefixes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action: restart"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — restart the BGP service on the node"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?wait=1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds (useful for synchronous checks)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All services require either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::remote-execute"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::service:{event}"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true},{"name":"event","in":"path","schemaId":"schema_324","description":"Event name to trigger on the node. This parameter is open-ended; the backend\nmay support additional event names beyond those with dedicated endpoints.","required":true}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"wait","in":"query","schemaId":"schema_288","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to block until the node responds and return its output. Omit for fire-and-forget."},"children":[]}]}]}]}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_325"}},"schemaId":"schema_325","pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/node/{nodeID}/trigger/{event}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"},{"name":"event","in":"path","required":true,"example":"gateway-routes","schemaId":"schema_324"}],"query":[{"name":"wait","in":"query","required":false,"schemaId":"schema_288"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_325"}},"responseCodes":["200"],"pointer":"/node/{nodeID}/trigger/{event}","href":"/agent/paths/~1node~1{nodeid}~1trigger~1{event}/post","summary":"Execute a remote operation or command on a specific node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_325","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_325"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}},"schemaId":"schema_326"}],"pointer":"/paths/~1node~1{nodeID}~1trigger~1{event}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_326","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_326"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1node~1{nodeid}~1trigger~1{event}/post"}],"panels":[]}]},"httpPath":"/node/{nodeID}/trigger/{event}"},{"label":"Update the lifecycle state of a specific node","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/agent/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put","routeSlug":"/agent/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put","metadata":{"seo":{"title":"Update the lifecycle state of a specific node","description":"Update the lifecycle state for a node (appliance or agent)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update the lifecycle state of a specific node","isWebhook":false,"pointer":"/paths/~1v2~1node~1{nodeID}~1lifecycle-state/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the lifecycle state of a specific node","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the lifecycle state for a node (appliance or agent)."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"nodeID","in":"path","schemaId":"schema_240","description":"Node ID","required":true}],"pointer":"/paths/~1v2~1node~1{nodeID}~1lifecycle-state/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LifecycleStateRequest"}},"schemaId":"components/schemas/LifecycleStateRequest","pointer":"/paths/~1v2~1node~1{nodeID}~1lifecycle-state/put/requestBody","description":"Lifecycle state update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/node/{nodeID}/lifecycle-state","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"nodeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/LifecycleStateRequest"}},"responseCodes":["200","404","422"],"pointer":"/v2/node/{nodeID}/lifecycle-state","href":"/agent/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put","summary":"Update the lifecycle state of a specific node"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/LifecycleStateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/LifecycleStateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"},{"code":"422","description":"Validation error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1node~1{nodeID}~1lifecycle-state/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/agent/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put"}],"panels":[]}]},"httpPath":"/v2/node/{nodeID}/lifecycle-state"}],"content":{"contentType":"group","meta":{"name":"Agent"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Agent","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/nodes/agents/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Agents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are lightweight software clients installed on user devices or servers, supporting VPN connectivity. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/node","summary":"Retrieve all network nodes including appliances and agents with filtering options","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agent/listnodes","deprecated":false},{"title":"/node/by-fqdn/{fqdn}","summary":"Retrieve a node by its fully-qualified domain name","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agent/getnodebyfqdn","deprecated":false},{"title":"/node/{nodeID}","summary":"Permanently remove a node from the organization and revoke access","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}/delete","deprecated":false},{"title":"/node/{nodeID}","summary":"Retrieve detailed configuration and status information for a specific node","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agent/getnode","deprecated":false},{"title":"/node/{nodeID}","summary":"Modify node settings including cluster assignment and operational state","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}/put","deprecated":false},{"title":"/node/{nodeID}/config/connectors","summary":"Configure inbound network connectors for external access to node services","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}~1config~1connectors/put","deprecated":false},{"title":"/node/{nodeID}/config/connectors","summary":"Remove all connector configurations from a node","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}~1config~1connectors/delete","deprecated":false},{"title":"/v2/node/{nodeID}/config/connectors","summary":"Create a new inbound connector to expose services running on the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors/post","deprecated":false},{"title":"/v2/node/{nodeID}/config/connectors/upgrade","summary":"Migrate a node's connector configuration to the latest V2 format","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1upgrade/post","deprecated":false},{"title":"/v2/node/{nodeID}/config/connectors/{connectorID}","summary":"Modify settings for an existing connector on a node","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/put","deprecated":false},{"title":"/v2/node/{nodeID}/config/connectors/{connectorID}","summary":"Remove a specific connector configuration from a node","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1connectors~1{connectorid}/delete","deprecated":false},{"title":"/node/{nodeID}/config/services","summary":"Configure outbound services for external connections from the node","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}~1config~1services/put","deprecated":false},{"title":"/v2/node/{nodeID}/config/services","summary":"Create a new outbound service connection for external resource access","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services/post","deprecated":false},{"title":"/v2/node/{nodeID}/config/services/upgrade","summary":"Migrate a node's service configuration to the latest V2 format","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1upgrade/post","deprecated":false},{"title":"/v2/node/{nodeID}/config/services/{serviceID}","summary":"Modify settings for an existing service connection on a node","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/put","deprecated":false},{"title":"/v2/node/{nodeID}/config/services/{serviceID}","summary":"Remove a specific service configuration from a node","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agent/paths/~1v2~1node~1{nodeid}~1config~1services~1{serviceid}/delete","deprecated":false},{"title":"/node/{nodeID}/config/gateway","summary":"Configure node as a network gateway for routing traffic between networks","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}~1config~1gateway/put","deprecated":false},{"title":"/node/{nodeID}/snmp","summary":"Configure SNMP monitoring settings for network management integration","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}~1snmp/put","deprecated":false},{"title":"/node/{nodeID}/tag/{tagName}","summary":"Remove a metadata tag from a node for organizational categorization","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/delete","deprecated":false},{"title":"/node/{nodeID}/tag/{tagName}","summary":"Add or update a metadata tag on a node for organizational categorization","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}~1tag~1{tagname}/put","deprecated":false},{"title":"/node/{nodeID}/trigger/gateway-perf","summary":"Run a throughput performance test to a peer gateway node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent/triggernodegatewayperf","deprecated":false},{"title":"/node/{nodeID}/trigger/gateway-ping","summary":"Ping a peer gateway node over the Trustgrid overlay","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent/triggernodegatewayping","deprecated":false},{"title":"/node/{nodeID}/trigger/node-debug","summary":"Stream plugin debug messages from the node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent/triggernodedebug","deprecated":false},{"title":"/node/{nodeID}/trigger/{event}","summary":"Execute a remote operation or command on a specific node","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agent/paths/~1node~1{nodeid}~1trigger~1{event}/post","deprecated":false},{"title":"/v2/node/{nodeID}/lifecycle-state","summary":"Update the lifecycle state of a specific node","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agent/paths/~1v2~1node~1{nodeid}~1lifecycle-state/put","deprecated":false}]}]}]}]}},{"type":"separator","label":"Upgrade Manager","content":null},{"type":"group","label":"Upgrade Manager","link":"/upgrade-manager","routeSlug":"/upgrade-manager","items":[{"label":"Retrieve all firmware upgrade campaigns and their execution status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/listupgrades","routeSlug":"/upgrade-manager/listupgrades","metadata":{"seo":{"title":"Retrieve all firmware upgrade campaigns and their execution status","description":"Requires upgrade-manager::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUpgrades","name":"Retrieve all firmware upgrade campaigns and their execution status","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all firmware upgrade campaigns and their execution status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/upgrade-manager/api/v1/upgrades","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/upgrade-manager/api/v1/upgrades","href":"/upgrade-manager/listupgrades","openApiOperationId":"listUpgrades","summary":"Retrieve all firmware upgrade campaigns and their execution status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341"}},"schemaId":"schema_341"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_341","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_341"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/listupgrades"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades"},{"label":"Create a new firmware upgrade campaign for multiple nodes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades/post","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades/post","metadata":{"seo":{"title":"Create a new firmware upgrade campaign for multiple nodes","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new firmware upgrade campaign for multiple nodes","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new firmware upgrade campaign for multiple nodes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/upgrade-manager/api/v1/upgrades","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/upgrade-manager/api/v1/upgrades","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades/post","summary":"Create a new firmware upgrade campaign for multiple nodes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}},"schemaId":"schema_342"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_342","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades/post"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades"},{"label":"Retrieve the currently running firmware upgrade campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/getactiveupgrade","routeSlug":"/upgrade-manager/getactiveupgrade","metadata":{"seo":{"title":"Retrieve the currently running firmware upgrade campaign","description":"Requires upgrade-manager::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getActiveUpgrade","name":"Retrieve the currently running firmware upgrade campaign","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1active/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the currently running firmware upgrade campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/upgrade-manager/api/v1/upgrades/active","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/active","href":"/upgrade-manager/getactiveupgrade","openApiOperationId":"getActiveUpgrade","summary":"Retrieve the currently running firmware upgrade campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Upgrade"}},"schemaId":"components/schemas/Upgrade"},{"code":"404","description":"Not Found - no upgrade is active"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1active/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Upgrade","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Upgrade"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/getactiveupgrade"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/active"},{"label":"Cancel and permanently remove an upgrade campaign","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/delete","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/delete","metadata":{"seo":{"title":"Cancel and permanently remove an upgrade campaign","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Cancel and permanently remove an upgrade campaign","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel and permanently remove an upgrade campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/delete","summary":"Cancel and permanently remove an upgrade campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/delete"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}"},{"label":"Retrieve detailed status and progress of a specific upgrade campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/getupgrade","routeSlug":"/upgrade-manager/getupgrade","metadata":{"seo":{"title":"Retrieve detailed status and progress of a specific upgrade campaign","description":"Requires upgrade-manager::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUpgrade","name":"Retrieve detailed status and progress of a specific upgrade campaign","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed status and progress of a specific upgrade campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}","href":"/upgrade-manager/getupgrade","openApiOperationId":"getUpgrade","summary":"Retrieve detailed status and progress of a specific upgrade campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Upgrade"}},"schemaId":"components/schemas/Upgrade"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Upgrade","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Upgrade"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/getupgrade"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}"},{"label":"Modify upgrade campaign settings and target selection criteria","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/put","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/put","metadata":{"seo":{"title":"Modify upgrade campaign settings and target selection criteria","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify upgrade campaign settings and target selection criteria","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify upgrade campaign settings and target selection criteria","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpgradeUpdateParams"}},"schemaId":"components/schemas/UpgradeUpdateParams","pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/put/requestBody","description":"Upgrade Input"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/UpgradeUpdateParams"}},"responseCodes":["200","404","422"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/put","summary":"Modify upgrade campaign settings and target selection criteria"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/UpgradeUpdateParams","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpgradeUpdateParams"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Upgrade"}},"schemaId":"components/schemas/Upgrade"},{"code":"404","description":"Not Found"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Upgrade","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Upgrade"}}},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/put"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}"},{"label":"Authorize automatic failover of HA clusters during upgrade process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1approve-failover/post","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1approve-failover/post","metadata":{"seo":{"title":"Authorize automatic failover of HA clusters during upgrade process","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Authorize automatic failover of HA clusters during upgrade process","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1approve-failover/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Authorize automatic failover of HA clusters during upgrade process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1approve-failover/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}/approve-failover","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}/approve-failover","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1approve-failover/post","summary":"Authorize automatic failover of HA clusters during upgrade process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1approve-failover/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1approve-failover/post"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}/approve-failover"},{"label":"Manually mark an upgrade campaign as finished and finalize the process","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1complete/post","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1complete/post","metadata":{"seo":{"title":"Manually mark an upgrade campaign as finished and finalize the process","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Manually mark an upgrade campaign as finished and finalize the process","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1complete/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Manually mark an upgrade campaign as finished and finalize the process","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1complete/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}/complete","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}/complete","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1complete/post","summary":"Manually mark an upgrade campaign as finished and finalize the process"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1complete/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1complete/post"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}/complete"},{"label":"Acknowledge and dismiss a failed or problematic upgrade workflow","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dismiss~1{workflowid}/post","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dismiss~1{workflowid}/post","metadata":{"seo":{"title":"Acknowledge and dismiss a failed or problematic upgrade workflow","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Acknowledge and dismiss a failed or problematic upgrade workflow","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1dismiss~1{workflowID}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Acknowledge and dismiss a failed or problematic upgrade workflow","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowID","in":"path","schemaId":"schema_240","description":"Unique ID of workflow","required":true},{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1dismiss~1{workflowID}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}/dismiss/{workflowID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"workflowID","in":"path","required":true,"schemaId":"schema_240"},{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}/dismiss/{workflowID}","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dismiss~1{workflowid}/post","summary":"Acknowledge and dismiss a failed or problematic upgrade workflow"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1dismiss~1{workflowID}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dismiss~1{workflowid}/post"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}/dismiss/{workflowID}"},{"label":"Test an upgrade campaign by creating and executing a non-destructive simulation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dryrun/post","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dryrun/post","metadata":{"seo":{"title":"Test an upgrade campaign by creating and executing a non-destructive simulation","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Test an upgrade campaign by creating and executing a non-destructive simulation","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1dryrun/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test an upgrade campaign by creating and executing a non-destructive simulation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1dryrun/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}/dryrun","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}/dryrun","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dryrun/post","summary":"Test an upgrade campaign by creating and executing a non-destructive simulation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}},"schemaId":"schema_342"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1dryrun/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_342","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_342"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dryrun/post"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}/dryrun"},{"label":"Retrieve detailed execution logs and error messages for an upgrade campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/getupgradelogs","routeSlug":"/upgrade-manager/getupgradelogs","metadata":{"seo":{"title":"Retrieve detailed execution logs and error messages for an upgrade campaign","description":"Requires upgrade-manager::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUpgradeLogs","name":"Retrieve detailed execution logs and error messages for an upgrade campaign","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1logs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed execution logs and error messages for an upgrade campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1logs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}/logs","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}/logs","href":"/upgrade-manager/getupgradelogs","openApiOperationId":"getUpgradeLogs","summary":"Retrieve detailed execution logs and error messages for an upgrade campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_343"}},"schemaId":"schema_343"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1logs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_343","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_343"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/getupgradelogs"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}/logs"},{"label":"Add administrative notes or comments to an upgrade workflow for tracking","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1note~1{workflowid}/post","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1note~1{workflowid}/post","metadata":{"seo":{"title":"Add administrative notes or comments to an upgrade workflow for tracking","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add administrative notes or comments to an upgrade workflow for tracking","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1note~1{workflowID}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add administrative notes or comments to an upgrade workflow for tracking","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowID","in":"path","schemaId":"schema_240","description":"Unique ID of workflow","required":true},{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1note~1{workflowID}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_344"}},"schemaId":"schema_344","pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1note~1{workflowID}/post/requestBody","description":"Note"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}/note/{workflowID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"workflowID","in":"path","required":true,"schemaId":"schema_240"},{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_344"}},"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}/note/{workflowID}","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1note~1{workflowid}/post","summary":"Add administrative notes or comments to an upgrade workflow for tracking"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_344","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_344"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1note~1{workflowID}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1note~1{workflowid}/post"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}/note/{workflowID}"},{"label":"Restart a failed upgrade workflow to attempt the operation again","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1retry~1{workflowid}/post","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1retry~1{workflowid}/post","metadata":{"seo":{"title":"Restart a failed upgrade workflow to attempt the operation again","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Restart a failed upgrade workflow to attempt the operation again","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1retry~1{workflowID}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Restart a failed upgrade workflow to attempt the operation again","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"workflowID","in":"path","schemaId":"schema_240","description":"Unique ID of workflow","required":true},{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1retry~1{workflowID}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}/retry/{workflowID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"workflowID","in":"path","required":true,"schemaId":"schema_240"},{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}/retry/{workflowID}","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1retry~1{workflowid}/post","summary":"Restart a failed upgrade workflow to attempt the operation again"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1retry~1{workflowID}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1retry~1{workflowid}/post"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}/retry/{workflowID}"},{"label":"Begin execution of a configured upgrade campaign across target nodes","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1start/post","routeSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1start/post","metadata":{"seo":{"title":"Begin execution of a configured upgrade campaign across target nodes","description":"Requires upgrade-manager::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Begin execution of a configured upgrade campaign across target nodes","isWebhook":false,"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1start/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Begin execution of a configured upgrade campaign across target nodes","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"upgradeID","in":"path","schemaId":"schema_240","description":"Unique ID of upgrade","required":true}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1start/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/upgrade-manager/api/v1/upgrades/{upgradeID}/start","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"upgradeID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/upgrade-manager/api/v1/upgrades/{upgradeID}/start","href":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1start/post","summary":"Begin execution of a configured upgrade campaign across target nodes"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeID}~1start/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1start/post"}],"panels":[]}]},"httpPath":"/upgrade-manager/api/v1/upgrades/{upgradeID}/start"}],"content":{"contentType":"group","meta":{"name":"Upgrade Manager"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upgrade Manager","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/upgrade-manager/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"upgrade manager"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" orchestrates software upgrades for nodes and clusters in bulk with scheduling and rollback support. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upgrade-manager::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/upgrade-manager/api/v1/upgrades","summary":"Retrieve all firmware upgrade campaigns and their execution status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/upgrade-manager/listupgrades","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades","summary":"Create a new firmware upgrade campaign for multiple nodes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades/post","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/active","summary":"Retrieve the currently running firmware upgrade campaign","prefix":{"name":"get","color":"get"},"badges":[],"link":"/upgrade-manager/getactiveupgrade","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}","summary":"Cancel and permanently remove an upgrade campaign","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/delete","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}","summary":"Retrieve detailed status and progress of a specific upgrade campaign","prefix":{"name":"get","color":"get"},"badges":[],"link":"/upgrade-manager/getupgrade","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}","summary":"Modify upgrade campaign settings and target selection criteria","prefix":{"name":"put","color":"put"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}/put","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}/approve-failover","summary":"Authorize automatic failover of HA clusters during upgrade process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1approve-failover/post","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}/complete","summary":"Manually mark an upgrade campaign as finished and finalize the process","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1complete/post","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}/dismiss/{workflowID}","summary":"Acknowledge and dismiss a failed or problematic upgrade workflow","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dismiss~1{workflowid}/post","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}/dryrun","summary":"Test an upgrade campaign by creating and executing a non-destructive simulation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1dryrun/post","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}/logs","summary":"Retrieve detailed execution logs and error messages for an upgrade campaign","prefix":{"name":"get","color":"get"},"badges":[],"link":"/upgrade-manager/getupgradelogs","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}/note/{workflowID}","summary":"Add administrative notes or comments to an upgrade workflow for tracking","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1note~1{workflowid}/post","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}/retry/{workflowID}","summary":"Restart a failed upgrade workflow to attempt the operation again","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1retry~1{workflowid}/post","deprecated":false},{"title":"/upgrade-manager/api/v1/upgrades/{upgradeID}/start","summary":"Begin execution of a configured upgrade campaign across target nodes","prefix":{"name":"post","color":"post"},"badges":[],"link":"/upgrade-manager/paths/~1upgrade-manager~1api~1v1~1upgrades~1{upgradeid}~1start/post","deprecated":false}]}]}]}]}},{"type":"separator","label":"Compute","content":null},{"type":"group","label":"Repository","link":"/repository","routeSlug":"/repository","items":[{"label":"Retrieve all container repositories available for edge computing","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/repository/listrepositories","routeSlug":"/repository/listrepositories","metadata":{"seo":{"title":"Retrieve all container repositories available for edge computing","description":"Retrieve all container repositories available for edge computing"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRepositories","name":"Retrieve all container repositories available for edge computing","isWebhook":false,"pointer":"/paths/~1repositories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all container repositories available for edge computing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/repositories","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/repositories","href":"/repository/listrepositories","openApiOperationId":"listRepositories","summary":"Retrieve all container repositories available for edge computing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_345"}},"schemaId":"schema_345"}],"pointer":"/paths/~1repositories/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_345","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_345"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/repository/listrepositories"}],"panels":[]}]},"httpPath":"/repositories"},{"label":"Permanently remove a container repository and all its images","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/repository/paths/~1repositories~1{reponame}/delete","routeSlug":"/repository/paths/~1repositories~1{reponame}/delete","metadata":{"seo":{"title":"Permanently remove a container repository and all its images","description":"Permanently remove a container repository and all its images"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Permanently remove a container repository and all its images","isWebhook":false,"pointer":"/paths/~1repositories~1{reponame}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permanently remove a container repository and all its images","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reponame","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1repositories~1{reponame}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/repositories/{reponame}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"reponame","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/repositories/{reponame}","href":"/repository/paths/~1repositories~1{reponame}/delete","summary":"Permanently remove a container repository and all its images"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1repositories~1{reponame}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/repository/paths/~1repositories~1{reponame}/delete"}],"panels":[]}]},"httpPath":"/repositories/{reponame}"},{"label":"Retrieve available image tags and metadata for a specific repository","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/repository/getrepository","routeSlug":"/repository/getrepository","metadata":{"seo":{"title":"Retrieve available image tags and metadata for a specific repository","description":"Retrieve available image tags and metadata for a specific repository"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRepository","name":"Retrieve available image tags and metadata for a specific repository","isWebhook":false,"pointer":"/paths/~1repositories~1{reponame}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve available image tags and metadata for a specific repository","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reponame","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1repositories~1{reponame}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/repositories/{reponame}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"reponame","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/repositories/{reponame}","href":"/repository/getrepository","openApiOperationId":"getRepository","summary":"Retrieve available image tags and metadata for a specific repository"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346"}},"schemaId":"schema_346"}],"pointer":"/paths/~1repositories~1{reponame}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_346","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_346"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/repository/getrepository"}],"panels":[]}]},"httpPath":"/repositories/{reponame}"},{"label":"Remove a specific image tag from a container repository","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/repository/paths/~1repositories~1{reponame}~1{tag}/delete","routeSlug":"/repository/paths/~1repositories~1{reponame}~1{tag}/delete","metadata":{"seo":{"title":"Remove a specific image tag from a container repository","description":"Remove a specific image tag from a container repository"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a specific image tag from a container repository","isWebhook":false,"pointer":"/paths/~1repositories~1{reponame}~1{tag}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a specific image tag from a container repository","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reponame","in":"path","schemaId":"schema_240","required":true},{"name":"tag","in":"path","schemaId":"schema_240","required":true}],"pointer":"/paths/~1repositories~1{reponame}~1{tag}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/repositories/{reponame}/{tag}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"reponame","in":"path","required":true,"schemaId":"schema_240"},{"name":"tag","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/repositories/{reponame}/{tag}","href":"/repository/paths/~1repositories~1{reponame}~1{tag}/delete","summary":"Remove a specific image tag from a container repository"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1repositories~1{reponame}~1{tag}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/repository/paths/~1repositories~1{reponame}~1{tag}/delete"}],"panels":[]}]},"httpPath":"/repositories/{reponame}/{tag}"}],"content":{"contentType":"group","meta":{"name":"Repository"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Repository","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Container image repositories for storing and distributing Docker images to edge compute nodes. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repositories::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/repositories","summary":"Retrieve all container repositories available for edge computing","prefix":{"name":"get","color":"get"},"badges":[],"link":"/repository/listrepositories","deprecated":false},{"title":"/repositories/{reponame}","summary":"Permanently remove a container repository and all its images","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/repository/paths/~1repositories~1{reponame}/delete","deprecated":false},{"title":"/repositories/{reponame}","summary":"Retrieve available image tags and metadata for a specific repository","prefix":{"name":"get","color":"get"},"badges":[],"link":"/repository/getrepository","deprecated":false},{"title":"/repositories/{reponame}/{tag}","summary":"Remove a specific image tag from a container repository","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/repository/paths/~1repositories~1{reponame}~1{tag}/delete","deprecated":false}]}]}]}]}},{"type":"separator","label":"Management","content":null},{"type":"group","label":"Audit","link":"/audit","routeSlug":"/audit","items":[{"label":"Retrieve network traffic flow logs with advanced filtering and pagination","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/getflowlogs","routeSlug":"/audit/getflowlogs","metadata":{"seo":{"title":"Retrieve network traffic flow logs with advanced filtering and pagination","description":"Requires audits::read:flows permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getFlowLogs","name":"Retrieve network traffic flow logs with advanced filtering and pagination","isWebhook":false,"pointer":"/paths/~1v2~1audit~1flow-logs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve network traffic flow logs with advanced filtering and pagination","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:flows"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_246","description":"Unix timestamp lower bound for the flow start time"},{"name":"eTime","in":"query","schemaId":"schema_246","description":"Unix timestamp upper bound for the flow start time. This does not filter by flow end time."},{"name":"eTimeOp","in":"query","schemaId":"schema_347","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow start time bound. There is no end-time query filter."},"children":[]}]}]}]},{"name":"protocol","in":"query","schemaId":"schema_240","description":"IP protocol"},{"name":"srcIp","in":"query","schemaId":"schema_240","description":"Source IP address"},{"name":"dstIp","in":"query","schemaId":"schema_240","description":"Destination IP address"},{"name":"srcPort","in":"query","schemaId":"schema_246","description":"Source port"},{"name":"srcPortOp","in":"query","schemaId":"schema_347","description":"Comparison operator for the source port"},{"name":"dstPort","in":"query","schemaId":"schema_246","description":"Destination port"},{"name":"dstPortOp","in":"query","schemaId":"schema_347","description":"Comparison operator for the dest port"},{"name":"limit","in":"query","schemaId":"schema_246","description":"Maximum number of results to return"},{"name":"srcNode","in":"query","schemaId":"schema_240","description":"Source node name"},{"name":"dstNode","in":"query","schemaId":"schema_240","description":"Dest node name"},{"name":"node","in":"query","schemaId":"schema_240","description":"Flow logging node ID"},{"name":"page","in":"query","schemaId":"schema_240","description":"Page of results to return"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort results, like "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"port:desc"},"children":[]}]}]}]},{"name":"reverse","in":"query","schemaId":"schema_266","description":"When true, newer flow logs will be listed first"},{"name":"tcpFlags","in":"query","schemaId":"schema_348","description":"If provided, a flow must match at least one of the TCP flags provided. Decimal encoded, see flow log TCP flag encoding."},{"name":"flags","in":"query","schemaId":"schema_348","description":"If provided, a flow must match at least one of the flow flags provided. Decimal encoded. Known flag values: 65536 (no ACL match), 131072 (no rule match), 262144 (no route), 524288 (invalid TCP), 67108864 (TLS cert expired), 134217728 (TLS name mismatch), 268435456 (TLS self-signed), 536870912 (TLS mutual auth required)."},{"name":"defunct","in":"query","schemaId":"schema_266","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true, returns only flows blocked or rejected by security controls — equivalent to filtering by the union of all defunct flow flags (no ACL, no rule, no route, invalid TCP, and all TLS error flags). Cannot be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flags"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"pointer":"/paths/~1v2~1audit~1flow-logs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/audit/flow-logs","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"sTime","in":"query","schemaId":"schema_246"},{"name":"eTime","in":"query","schemaId":"schema_246"},{"name":"eTimeOp","in":"query","schemaId":"schema_347"},{"name":"protocol","in":"query","schemaId":"schema_240"},{"name":"srcIp","in":"query","schemaId":"schema_240"},{"name":"dstIp","in":"query","schemaId":"schema_240"},{"name":"srcPort","in":"query","schemaId":"schema_246"},{"name":"srcPortOp","in":"query","schemaId":"schema_347"},{"name":"dstPort","in":"query","schemaId":"schema_246"},{"name":"dstPortOp","in":"query","schemaId":"schema_347"},{"name":"limit","in":"query","schemaId":"schema_246"},{"name":"srcNode","in":"query","schemaId":"schema_240"},{"name":"dstNode","in":"query","schemaId":"schema_240"},{"name":"node","in":"query","schemaId":"schema_240"},{"name":"page","in":"query","schemaId":"schema_240"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"reverse","in":"query","schemaId":"schema_266"},{"name":"tcpFlags","in":"query","schemaId":"schema_348","style":"form","explode":false},{"name":"flags","in":"query","schemaId":"schema_348","style":"form","explode":false},{"name":"defunct","in":"query","schemaId":"schema_266"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/audit/flow-logs","href":"/audit/getflowlogs","openApiOperationId":"getFlowLogs","summary":"Retrieve network traffic flow logs with advanced filtering and pagination"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}},"schemaId":"schema_349","headers":{"x-total-count":{"description":"Total number of flows matching query","schema":{"type":"number"}}},"headerSchemaId":"schema_350"}],"pointer":"/paths/~1v2~1audit~1flow-logs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_349","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/getflowlogs"}],"panels":[]}]},"httpPath":"/v2/audit/flow-logs"},{"label":"List authentication audit events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/listauthaudits","routeSlug":"/audit/listauthaudits","metadata":{"seo":{"title":"List authentication audit events","description":"Returns a paginated list of authentication audit events for the organization, such as portal logins and API key usage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAuthAudits","name":"List authentication audit events","isWebhook":false,"pointer":"/paths/~1v2~1audit~1auth/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List authentication audit events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of authentication audit events for the organization, such as portal logins and API key usage."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-total-count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header contains the total number of records matching the query."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_240","description":"Start time (ISO 8601) to query from"},{"name":"eTime","in":"query","schemaId":"schema_240","description":"End time (ISO 8601) to query to"},{"name":"page","in":"query","schemaId":"schema_351","description":"Page number (1-based)"},{"name":"limit","in":"query","schemaId":"schema_352","description":"Maximum number of results per page (max 200)"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field and direction, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp:desc"},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_240","description":"Free-text search query"},{"name":"ips","in":"query","schemaId":"schema_243","description":"Filter by IP addresses"},{"name":"userIDs","in":"query","schemaId":"schema_243","description":"Filter by user IDs"}],"pointer":"/paths/~1v2~1audit~1auth/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/audit/auth","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"sTime","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"page","in":"query","schemaId":"schema_351"},{"name":"limit","in":"query","schemaId":"schema_352"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"},{"name":"ips","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"userIDs","in":"query","schemaId":"schema_243","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/audit/auth","href":"/audit/listauthaudits","openApiOperationId":"listAuthAudits","summary":"List authentication audit events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}},"schemaId":"schema_353","headers":{"x-total-count":{"description":"Total number of records matching the query","schema":{"type":"integer"}}},"headerSchemaId":"schema_354"}],"pointer":"/paths/~1v2~1audit~1auth/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_353","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_353"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/listauthaudits"}],"panels":[]}]},"httpPath":"/v2/audit/auth"},{"label":"Download authentication audit events as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/downloadauthaudits","routeSlug":"/audit/downloadauthaudits","metadata":{"seo":{"title":"Download authentication audit events as CSV","description":"Exports all authentication audit events matching the query as a CSV file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadAuthAudits","name":"Download authentication audit events as CSV","isWebhook":false,"pointer":"/paths/~1v2~1audit~1auth~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download authentication audit events as CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports all authentication audit events matching the query as a CSV file."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_240","description":"Start time (ISO 8601) to query from"},{"name":"eTime","in":"query","schemaId":"schema_240","description":"End time (ISO 8601) to query to"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field and direction, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp:desc"},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_240","description":"Free-text search query"},{"name":"ips","in":"query","schemaId":"schema_243","description":"Filter by IP addresses"},{"name":"userIDs","in":"query","schemaId":"schema_243","description":"Filter by user IDs"},{"name":"fields","in":"query","schemaId":"schema_243","description":"CSV columns to include. When omitted, all columns are included."}],"pointer":"/paths/~1v2~1audit~1auth~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/audit/auth/download","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"sTime","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"},{"name":"ips","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"userIDs","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"fields","in":"query","schemaId":"schema_243","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/audit/auth/download","href":"/audit/downloadauthaudits","openApiOperationId":"downloadAuthAudits","summary":"Download authentication audit events as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_240"}},"schemaId":"schema_240"}],"pointer":"/paths/~1v2~1audit~1auth~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_240","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_240"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/downloadauthaudits"}],"panels":[]}]},"httpPath":"/v2/audit/auth/download"},{"label":"Get configuration audit metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/getchangeauditconfig","routeSlug":"/audit/getchangeauditconfig","metadata":{"seo":{"title":"Get configuration audit metadata","description":"Returns the available audit event types and item types used for filtering configuration change audits."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getChangeAuditConfig","name":"Get configuration audit metadata","isWebhook":false,"pointer":"/paths/~1v2~1audit~1change-config/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get configuration audit metadata","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the available audit event types and item types used for filtering configuration change audits."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/audit/change-config","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/audit/change-config","href":"/audit/getchangeauditconfig","openApiOperationId":"getChangeAuditConfig","summary":"Get configuration audit metadata"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeAuditConfig"}},"schemaId":"components/schemas/ChangeAuditConfig"}],"pointer":"/paths/~1v2~1audit~1change-config/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ChangeAuditConfig","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ChangeAuditConfig"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/getchangeauditconfig"}],"panels":[]}]},"httpPath":"/v2/audit/change-config"},{"label":"List configuration change audit events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/listchangeaudits","routeSlug":"/audit/listchangeaudits","metadata":{"seo":{"title":"List configuration change audit events","description":"Returns a paginated list of configuration change audit events for the organization."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listChangeAudits","name":"List configuration change audit events","isWebhook":false,"pointer":"/paths/~1v2~1audit~1changes/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List configuration change audit events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of configuration change audit events for the organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-total-count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header contains the total number of records matching the query."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_240","description":"Start time (ISO 8601) to query from"},{"name":"eTime","in":"query","schemaId":"schema_240","description":"End time (ISO 8601) to query to"},{"name":"page","in":"query","schemaId":"schema_351","description":"Page number (1-based)"},{"name":"limit","in":"query","schemaId":"schema_355","description":"Maximum number of results per page (max 10000)"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field and direction, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp:desc"},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_240","description":"Free-text search query"},{"name":"auditTypes","in":"query","schemaId":"schema_243","description":"Filter by audit event types (e.g. create, delete, change, action)"},{"name":"itemTypes","in":"query","schemaId":"schema_243","description":"Filter by item types (e.g. Node, Cluster)"},{"name":"userNames","in":"query","schemaId":"schema_243","description":"Filter by user names"},{"name":"itemIDs","in":"query","schemaId":"schema_243","description":"Filter by item IDs"},{"name":"ips","in":"query","schemaId":"schema_243","description":"Filter by IP addresses"}],"pointer":"/paths/~1v2~1audit~1changes/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/audit/changes","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"sTime","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"page","in":"query","schemaId":"schema_351"},{"name":"limit","in":"query","schemaId":"schema_355"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"},{"name":"auditTypes","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"itemTypes","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"userNames","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"itemIDs","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"ips","in":"query","schemaId":"schema_243","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/audit/changes","href":"/audit/listchangeaudits","openApiOperationId":"listChangeAudits","summary":"List configuration change audit events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}},"schemaId":"schema_356","headers":{"x-total-count":{"description":"Total number of records matching the query","schema":{"type":"integer"}}},"headerSchemaId":"schema_354"}],"pointer":"/paths/~1v2~1audit~1changes/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_356","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_356"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/listchangeaudits"}],"panels":[]}]},"httpPath":"/v2/audit/changes"},{"label":"Download configuration change audit events as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/downloadchangeaudits","routeSlug":"/audit/downloadchangeaudits","metadata":{"seo":{"title":"Download configuration change audit events as CSV","description":"Exports all configuration change audit events matching the query as a CSV file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadChangeAudits","name":"Download configuration change audit events as CSV","isWebhook":false,"pointer":"/paths/~1v2~1audit~1changes~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download configuration change audit events as CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports all configuration change audit events matching the query as a CSV file."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_240","description":"Start time (ISO 8601) to query from"},{"name":"eTime","in":"query","schemaId":"schema_240","description":"End time (ISO 8601) to query to"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field and direction, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp:desc"},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_240","description":"Free-text search query"},{"name":"auditTypes","in":"query","schemaId":"schema_243","description":"Filter by audit event types (e.g. create, delete, change, action)"},{"name":"itemTypes","in":"query","schemaId":"schema_243","description":"Filter by item types (e.g. Node, Cluster)"},{"name":"userNames","in":"query","schemaId":"schema_243","description":"Filter by user names"},{"name":"itemIDs","in":"query","schemaId":"schema_243","description":"Filter by item IDs"},{"name":"ips","in":"query","schemaId":"schema_243","description":"Filter by IP addresses"},{"name":"fields","in":"query","schemaId":"schema_243","description":"CSV columns to include. When omitted, all columns are included."}],"pointer":"/paths/~1v2~1audit~1changes~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/audit/changes/download","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"sTime","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"},{"name":"auditTypes","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"itemTypes","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"userNames","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"itemIDs","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"ips","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"fields","in":"query","schemaId":"schema_243","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/audit/changes/download","href":"/audit/downloadchangeaudits","openApiOperationId":"downloadChangeAudits","summary":"Download configuration change audit events as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_240"}},"schemaId":"schema_240"}],"pointer":"/paths/~1v2~1audit~1changes~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_240","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_240"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/downloadchangeaudits"}],"panels":[]}]},"httpPath":"/v2/audit/changes/download"},{"label":"List node audit events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/listnodeaudits","routeSlug":"/audit/listnodeaudits","metadata":{"seo":{"title":"List node audit events","description":"Returns a paginated list of node audit events for the organization, such as connects, disconnects, and other node actions."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNodeAudits","name":"List node audit events","isWebhook":false,"pointer":"/paths/~1v2~1audit~1node/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List node audit events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a paginated list of node audit events for the organization, such as connects, disconnects, and other node actions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-total-count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header contains the total number of records matching the query."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_240","description":"Start time (ISO 8601) to query from"},{"name":"eTime","in":"query","schemaId":"schema_240","description":"End time (ISO 8601) to query to"},{"name":"page","in":"query","schemaId":"schema_351","description":"Page number (1-based)"},{"name":"limit","in":"query","schemaId":"schema_352","description":"Maximum number of results per page (max 200)"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field and direction, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp:desc"},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_240","description":"Free-text search query"},{"name":"categories","in":"query","schemaId":"schema_243","description":"Filter by event categories"},{"name":"fqdns","in":"query","schemaId":"schema_243","description":"Filter by node FQDNs"}],"pointer":"/paths/~1v2~1audit~1node/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/audit/node","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"sTime","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"page","in":"query","schemaId":"schema_351"},{"name":"limit","in":"query","schemaId":"schema_352"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"},{"name":"categories","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"fqdns","in":"query","schemaId":"schema_243","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/audit/node","href":"/audit/listnodeaudits","openApiOperationId":"listNodeAudits","summary":"List node audit events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}},"schemaId":"schema_357","headers":{"x-total-count":{"description":"Total number of records matching the query","schema":{"type":"integer"}}},"headerSchemaId":"schema_354"}],"pointer":"/paths/~1v2~1audit~1node/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_357","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_357"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/listnodeaudits"}],"panels":[]}]},"httpPath":"/v2/audit/node"},{"label":"Get node audit event categories","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/getnodeauditcategories","routeSlug":"/audit/getnodeauditcategories","metadata":{"seo":{"title":"Get node audit event categories","description":"Returns the list of available node audit event categories used for filtering."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNodeAuditCategories","name":"Get node audit event categories","isWebhook":false,"pointer":"/paths/~1v2~1audit~1node-categories/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get node audit event categories","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the list of available node audit event categories used for filtering."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/audit/node-categories","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/audit/node-categories","href":"/audit/getnodeauditcategories","openApiOperationId":"getNodeAuditCategories","summary":"Get node audit event categories"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}},"schemaId":"schema_243"}],"pointer":"/paths/~1v2~1audit~1node-categories/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_243","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/getnodeauditcategories"}],"panels":[]}]},"httpPath":"/v2/audit/node-categories"},{"label":"Download node audit events as CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/downloadnodeaudits","routeSlug":"/audit/downloadnodeaudits","metadata":{"seo":{"title":"Download node audit events as CSV","description":"Exports all node audit events matching the query as a CSV file."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadNodeAudits","name":"Download node audit events as CSV","isWebhook":false,"pointer":"/paths/~1v2~1audit~1node~1download/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download node audit events as CSV","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Exports all node audit events matching the query as a CSV file."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_240","description":"Start time (ISO 8601) to query from"},{"name":"eTime","in":"query","schemaId":"schema_240","description":"End time (ISO 8601) to query to"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field and direction, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"timestamp:desc"},"children":[]}]}]}]},{"name":"q","in":"query","schemaId":"schema_240","description":"Free-text search query"},{"name":"categories","in":"query","schemaId":"schema_243","description":"Filter by event categories"},{"name":"fqdns","in":"query","schemaId":"schema_243","description":"Filter by node FQDNs"},{"name":"fields","in":"query","schemaId":"schema_243","description":"CSV columns to include. When omitted, all columns are included."}],"pointer":"/paths/~1v2~1audit~1node~1download/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/audit/node/download","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"sTime","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"},{"name":"categories","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"fqdns","in":"query","schemaId":"schema_243","style":"form","explode":true},{"name":"fields","in":"query","schemaId":"schema_243","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/audit/node/download","href":"/audit/downloadnodeaudits","openApiOperationId":"downloadNodeAudits","summary":"Download node audit events as CSV"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"text/csv","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_240"}},"schemaId":"schema_240"}],"pointer":"/paths/~1v2~1audit~1node~1download/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_240","mediaTypes":["text/csv"],"mediaTypeContent":{"text/csv":{"schemaId":"schema_240"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/downloadnodeaudits"}],"panels":[]}]},"httpPath":"/v2/audit/node/download"},{"label":"Export configuration change audit logs as a downloadable file","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/downloadconfigaudit","routeSlug":"/audit/downloadconfigaudit","metadata":{"seo":{"title":"Export configuration change audit logs as a downloadable file","description":"This is deprecated; use /v2/audit/changes/download instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadConfigAudit","name":"Export configuration change audit logs as a downloadable file","deprecated":true,"isWebhook":false,"pointer":"/paths/~1audit~1download~1config/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export configuration change audit logs as a downloadable file","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is deprecated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/audit/changes/download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemID","in":"query","schemaId":"schema_240","description":"ID for the item to audit. If specified, must include itemType."},{"name":"itemType","in":"query","schemaId":"schema_240","description":"Type of item to audit, e.g., Node or Cluster. If specified, must include itemID"},{"name":"timestamp","in":"query","schemaId":"schema_240","description":"Start time (unix timestamp) to query from"},{"name":"eTime","in":"query","schemaId":"schema_240","description":"End time (unix timestamp) to query to"},{"name":"auditEvent","in":"query","schemaId":"schema_240","description":"Audit type to filter (create, delete, change, or action)"},{"name":"ip","in":"query","schemaId":"schema_240","description":"IP address filter"},{"name":"user","in":"query","schemaId":"schema_240","description":"User name filter"},{"name":"details","in":"query","schemaId":"schema_240","description":"Details text filter"}],"pointer":"/paths/~1audit~1download~1config/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audit/download/config","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"itemID","in":"query","schemaId":"schema_240"},{"name":"itemType","in":"query","schemaId":"schema_240"},{"name":"timestamp","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"auditEvent","in":"query","schemaId":"schema_240"},{"name":"ip","in":"query","schemaId":"schema_240"},{"name":"user","in":"query","schemaId":"schema_240"},{"name":"details","in":"query","schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/audit/download/config","href":"/audit/downloadconfigaudit","openApiOperationId":"downloadConfigAudit","summary":"Export configuration change audit logs as a downloadable file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1audit~1download~1config/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/downloadconfigaudit"}],"panels":[]}]},"httpPath":"/audit/download/config"},{"label":"Export node activity and operational audit logs as a downloadable file","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/downloadnodeaudit","routeSlug":"/audit/downloadnodeaudit","metadata":{"seo":{"title":"Export node activity and operational audit logs as a downloadable file","description":"This is deprecated; use /v2/audit/node/download instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadNodeAudit","name":"Export node activity and operational audit logs as a downloadable file","deprecated":true,"isWebhook":false,"pointer":"/paths/~1audit~1download~1node/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export node activity and operational audit logs as a downloadable file","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is deprecated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/audit/node/download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"timestamp","in":"query","schemaId":"schema_240","description":"Start time (unix timestamp) to query from"},{"name":"FQDN","in":"query","schemaId":"schema_240","description":"Node FQDN"}],"pointer":"/paths/~1audit~1download~1node/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audit/download/node","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"timestamp","in":"query","schemaId":"schema_240"},{"name":"FQDN","in":"query","schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/audit/download/node","href":"/audit/downloadnodeaudit","openApiOperationId":"downloadNodeAudit","summary":"Export node activity and operational audit logs as a downloadable file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1audit~1download~1node/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/downloadnodeaudit"}],"panels":[]}]},"httpPath":"/audit/download/node"},{"label":"Export user authentication and access audit logs as a downloadable file","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/downloaduseraudit","routeSlug":"/audit/downloaduseraudit","metadata":{"seo":{"title":"Export user authentication and access audit logs as a downloadable file","description":"This is deprecated; use /v2/audit/auth/download instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"downloadUserAudit","name":"Export user authentication and access audit logs as a downloadable file","deprecated":true,"isWebhook":false,"pointer":"/paths/~1audit~1download~1user/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Export user authentication and access audit logs as a downloadable file","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is deprecated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/audit/auth/download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audit/download/user","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/audit/download/user","href":"/audit/downloaduseraudit","openApiOperationId":"downloadUserAudit","summary":"Export user authentication and access audit logs as a downloadable file"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1audit~1download~1user/get/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/downloaduseraudit"}],"panels":[]}]},"httpPath":"/audit/download/user"},{"label":"Retrieve real-time configuration change audit logs with filtering options","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/tailconfigaudit","routeSlug":"/audit/tailconfigaudit","metadata":{"seo":{"title":"Retrieve real-time configuration change audit logs with filtering options","description":"This is deprecated; use /v2/audit/changes instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tailConfigAudit","name":"Retrieve real-time configuration change audit logs with filtering options","deprecated":true,"isWebhook":false,"pointer":"/paths/~1audit~1tail~1config/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve real-time configuration change audit logs with filtering options","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is deprecated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/audit/changes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"itemID","in":"query","schemaId":"schema_240","description":"ID for the item to audit. If specified, must include itemType."},{"name":"itemType","in":"query","schemaId":"schema_240","description":"Type of item to audit, e.g., Node or Cluster. If specified, must include itemID"},{"name":"timestamp","in":"query","schemaId":"schema_240","description":"Start time (unix timestamp) to query from"},{"name":"eTime","in":"query","schemaId":"schema_240","description":"End time (unix timestamp) to query to"},{"name":"auditEvent","in":"query","schemaId":"schema_240","description":"Audit type to filter (create, delete, change, or action)"},{"name":"ip","in":"query","schemaId":"schema_240","description":"IP address filter"},{"name":"user","in":"query","schemaId":"schema_240","description":"User name filter"},{"name":"details","in":"query","schemaId":"schema_240","description":"Details text filter"}],"pointer":"/paths/~1audit~1tail~1config/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audit/tail/config","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"itemID","in":"query","schemaId":"schema_240"},{"name":"itemType","in":"query","schemaId":"schema_240"},{"name":"timestamp","in":"query","schemaId":"schema_240"},{"name":"eTime","in":"query","schemaId":"schema_240"},{"name":"auditEvent","in":"query","schemaId":"schema_240"},{"name":"ip","in":"query","schemaId":"schema_240"},{"name":"user","in":"query","schemaId":"schema_240"},{"name":"details","in":"query","schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/audit/tail/config","href":"/audit/tailconfigaudit","openApiOperationId":"tailConfigAudit","summary":"Retrieve real-time configuration change audit logs with filtering options"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358"}},"schemaId":"schema_358"}],"pointer":"/paths/~1audit~1tail~1config/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_358","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_358"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/tailconfigaudit"}],"panels":[]}]},"httpPath":"/audit/tail/config"},{"label":"Retrieve network traffic flow logs with advanced filtering and pagination","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/tailflowlogs","routeSlug":"/audit/tailflowlogs","metadata":{"seo":{"title":"Retrieve network traffic flow logs with advanced filtering and pagination","description":"This is deprecated; use /v2/audit/flow-logs instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tailFlowLogs","name":"Retrieve network traffic flow logs with advanced filtering and pagination","deprecated":true,"isWebhook":false,"pointer":"/paths/~1audit~1tail~1flow_logs/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve network traffic flow logs with advanced filtering and pagination","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is deprecated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/audit/flow-logs"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:flows"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sTime","in":"query","schemaId":"schema_246","description":"Unix timestamp lower bound for the flow start time"},{"name":"eTime","in":"query","schemaId":"schema_246","description":"Unix timestamp upper bound for the flow start time. This does not filter by flow end time."},{"name":"eTimeOp","in":"query","schemaId":"schema_347","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comparison operator for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" flow start time bound. There is no end-time query filter."},"children":[]}]}]}]},{"name":"protocol","in":"query","schemaId":"schema_240","description":"IP protocol"},{"name":"srcIp","in":"query","schemaId":"schema_240","description":"Source IP address"},{"name":"dstIp","in":"query","schemaId":"schema_240","description":"Destination IP address"},{"name":"srcPort","in":"query","schemaId":"schema_246","description":"Source port"},{"name":"srcPortOp","in":"query","schemaId":"schema_347","description":"Comparison operator for the source port"},{"name":"dstPort","in":"query","schemaId":"schema_246","description":"Destination port"},{"name":"dstPortOp","in":"query","schemaId":"schema_347","description":"Comparison operator for the dest port"},{"name":"limit","in":"query","schemaId":"schema_246","description":"Maximum number of results to return"},{"name":"srcNode","in":"query","schemaId":"schema_240","description":"Source node name"},{"name":"dstNode","in":"query","schemaId":"schema_240","description":"Dest node name"},{"name":"node","in":"query","schemaId":"schema_240","description":"Flow logging node ID"},{"name":"reverse","in":"query","schemaId":"schema_266","description":"When true, newer flow logs will be listed first"},{"name":"tcpFlags","in":"query","schemaId":"schema_348","description":"If provided, a flow must match at least one of the TCP flags provided. Decimal encoded, see flow log TCP flag encoding."},{"name":"cursor","in":"query","schemaId":"schema_240","description":"Continuation cursor from previous query"}],"pointer":"/paths/~1audit~1tail~1flow_logs/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audit/tail/flow_logs","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"sTime","in":"query","schemaId":"schema_246"},{"name":"eTime","in":"query","schemaId":"schema_246"},{"name":"eTimeOp","in":"query","schemaId":"schema_347"},{"name":"protocol","in":"query","schemaId":"schema_240"},{"name":"srcIp","in":"query","schemaId":"schema_240"},{"name":"dstIp","in":"query","schemaId":"schema_240"},{"name":"srcPort","in":"query","schemaId":"schema_246"},{"name":"srcPortOp","in":"query","schemaId":"schema_347"},{"name":"dstPort","in":"query","schemaId":"schema_246"},{"name":"dstPortOp","in":"query","schemaId":"schema_347"},{"name":"limit","in":"query","schemaId":"schema_246"},{"name":"srcNode","in":"query","schemaId":"schema_240"},{"name":"dstNode","in":"query","schemaId":"schema_240"},{"name":"node","in":"query","schemaId":"schema_240"},{"name":"reverse","in":"query","schemaId":"schema_266"},{"name":"tcpFlags","in":"query","schemaId":"schema_348","style":"form","explode":false},{"name":"cursor","in":"query","schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/audit/tail/flow_logs","href":"/audit/tailflowlogs","openApiOperationId":"tailFlowLogs","summary":"Retrieve network traffic flow logs with advanced filtering and pagination"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}},"schemaId":"schema_349","headers":{"x-cursor":{"description":"Continuation cursor for the next query","schema":{"type":"string"}}},"headerSchemaId":"schema_359"}],"pointer":"/paths/~1audit~1tail~1flow_logs/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_349","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_349"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/tailflowlogs"}],"panels":[]}]},"httpPath":"/audit/tail/flow_logs"},{"label":"Retrieve real-time node operational and security audit logs","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/tailnodeaudit","routeSlug":"/audit/tailnodeaudit","metadata":{"seo":{"title":"Retrieve real-time node operational and security audit logs","description":"This is deprecated; use /v2/audit/node instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tailNodeAudit","name":"Retrieve real-time node operational and security audit logs","deprecated":true,"isWebhook":false,"pointer":"/paths/~1audit~1tail~1node/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve real-time node operational and security audit logs","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is deprecated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/audit/node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List node (appliance or agent) audits"},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"timestamp","in":"query","schemaId":"schema_240","description":"Start time (unix timestamp) to query from"},{"name":"FQDN","in":"query","schemaId":"schema_240","description":"Node FQDN"}],"pointer":"/paths/~1audit~1tail~1node/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audit/tail/node","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"timestamp","in":"query","schemaId":"schema_240"},{"name":"FQDN","in":"query","schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/audit/tail/node","href":"/audit/tailnodeaudit","openApiOperationId":"tailNodeAudit","summary":"Retrieve real-time node operational and security audit logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}},"schemaId":"schema_360"}],"pointer":"/paths/~1audit~1tail~1node/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_360","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_360"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/tailnodeaudit"}],"panels":[]}]},"httpPath":"/audit/tail/node"},{"label":"Retrieve real-time user authentication and session audit logs","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/audit/tailuseraudit","routeSlug":"/audit/tailuseraudit","metadata":{"seo":{"title":"Retrieve real-time user authentication and session audit logs","description":"This is deprecated; use /v2/audit/auth instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"tailUserAudit","name":"Retrieve real-time user authentication and session audit logs","deprecated":true,"isWebhook":false,"pointer":"/paths/~1audit~1tail~1user/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve real-time user authentication and session audit logs","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is deprecated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/v2/audit/auth"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/audit/tail/user","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/audit/tail/user","href":"/audit/tailuseraudit","openApiOperationId":"tailUserAudit","summary":"Retrieve real-time user authentication and session audit logs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361"}},"schemaId":"schema_361"}],"pointer":"/paths/~1audit~1tail~1user/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_361","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_361"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/audit/tailuseraudit"}],"panels":[]}]},"httpPath":"/audit/tail/user"}],"content":{"contentType":"group","meta":{"name":"Audit"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Audit","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Immutable logs for compliance and troubleshooting. Trustgrid exposes "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/operations/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"authentication audits"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/operations/changes/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"configuration changes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/operations/node-events/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"node events"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:node"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/operations/flow-logs/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"flow logs"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"audits::read:flows"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/audit/flow-logs","summary":"Retrieve network traffic flow logs with advanced filtering and pagination","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/getflowlogs","deprecated":false},{"title":"/v2/audit/auth","summary":"List authentication audit events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/listauthaudits","deprecated":false},{"title":"/v2/audit/auth/download","summary":"Download authentication audit events as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/downloadauthaudits","deprecated":false},{"title":"/v2/audit/change-config","summary":"Get configuration audit metadata","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/getchangeauditconfig","deprecated":false},{"title":"/v2/audit/changes","summary":"List configuration change audit events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/listchangeaudits","deprecated":false},{"title":"/v2/audit/changes/download","summary":"Download configuration change audit events as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/downloadchangeaudits","deprecated":false},{"title":"/v2/audit/node","summary":"List node audit events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/listnodeaudits","deprecated":false},{"title":"/v2/audit/node-categories","summary":"Get node audit event categories","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/getnodeauditcategories","deprecated":false},{"title":"/v2/audit/node/download","summary":"Download node audit events as CSV","prefix":{"name":"get","color":"get"},"badges":[],"link":"/audit/downloadnodeaudits","deprecated":false},{"title":"/audit/download/config","summary":"Export configuration change audit logs as a downloadable file","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/audit/downloadconfigaudit","deprecated":true},{"title":"/audit/download/node","summary":"Export node activity and operational audit logs as a downloadable file","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/audit/downloadnodeaudit","deprecated":true},{"title":"/audit/download/user","summary":"Export user authentication and access audit logs as a downloadable file","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/audit/downloaduseraudit","deprecated":true},{"title":"/audit/tail/config","summary":"Retrieve real-time configuration change audit logs with filtering options","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/audit/tailconfigaudit","deprecated":true},{"title":"/audit/tail/flow_logs","summary":"Retrieve network traffic flow logs with advanced filtering and pagination","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/audit/tailflowlogs","deprecated":true},{"title":"/audit/tail/node","summary":"Retrieve real-time node operational and security audit logs","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/audit/tailnodeaudit","deprecated":true},{"title":"/audit/tail/user","summary":"Retrieve real-time user authentication and session audit logs","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/audit/tailuseraudit","deprecated":true}]}]}]}]}},{"type":"group","label":"Auth Group","link":"/auth-group","routeSlug":"/auth-group","items":[{"label":"List a network's auth groups","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/auth-group/listnetworkauthgroups","routeSlug":"/auth-group/listnetworkauthgroups","metadata":{"seo":{"title":"List a network's auth groups","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listNetworkAuthGroups","name":"List a network's auth groups","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network's auth groups","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/auth-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group","href":"/auth-group/listnetworkauthgroups","openApiOperationId":"listNetworkAuthGroups","summary":"List a network's auth groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}},"schemaId":"schema_255"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_255","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_255"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-group/listnetworkauthgroups"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group"},{"label":"Create a network auth group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","routeSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","metadata":{"seo":{"title":"Create a network auth group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a network auth group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a network auth group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post/requestBody","description":"Network auth group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/auth-group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group","href":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","summary":"Create a network auth group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group"},{"label":"Delete a network auth group","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","routeSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","metadata":{"seo":{"title":"Delete a network auth group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Delete a network auth group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a network auth group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","summary":"Delete a network auth group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"List a network auth group's members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/auth-group/getnetworkauthgroup","routeSlug":"/auth-group/getnetworkauthgroup","metadata":{"seo":{"title":"List a network auth group's members","description":"Requires virtual-networks::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getNetworkAuthGroup","name":"List a network auth group's members","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a network auth group's members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/auth-group/getnetworkauthgroup","openApiOperationId":"getNetworkAuthGroup","summary":"List a network auth group's members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256"}},"schemaId":"schema_256"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_256","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_256"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-group/getnetworkauthgroup"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"Add a network auth group member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","routeSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","metadata":{"seo":{"title":"Add a network auth group member","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a network auth group member","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a network auth group member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post/requestBody","description":"Network auth group member"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","summary":"Add a network auth group member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"Update a network auth group","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","routeSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","metadata":{"seo":{"title":"Update a network auth group","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a network auth group","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a network auth group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put/requestBody","description":"Network auth group configuration"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","href":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","summary":"Update a network auth group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroup"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}"},{"label":"Remove a network auth group member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","routeSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","metadata":{"seo":{"title":"Remove a network auth group member","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a network auth group member","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a network auth group member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberID","in":"path","schemaId":"schema_240","description":"Group member ID","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"memberID","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","href":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","summary":"Remove a network auth group member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}"},{"label":"Update a membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","routeSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","metadata":{"seo":{"title":"Update a membership","description":"Requires virtual-networks::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Update a membership","isWebhook":false,"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a membership","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"virtual-networks::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"memberID","in":"path","schemaId":"schema_240","description":"Group member ID","required":true},{"name":"groupName","in":"path","schemaId":"schema_240","description":"Network auth group name","required":true},{"name":"networkName","in":"path","schemaId":"schema_240","description":"Network name","required":true},{"name":"domainName","in":"path","schemaId":"schema_240","description":"Domain name","required":true}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put/requestBody","description":"Network auth group member"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"memberID","in":"path","required":true,"schemaId":"schema_240"},{"name":"groupName","in":"path","required":true,"schemaId":"schema_240"},{"name":"networkName","in":"path","required":true,"schemaId":"schema_240"},{"name":"domainName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"responseCodes":["200","422"],"pointer":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","href":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","summary":"Update a membership"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/VirtualNetworkAuthorizationGroupMembership"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1domain~1{domainName}~1network~1{networkName}~1auth-group~1{groupName}~1{memberID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put"}],"panels":[]}]},"httpPath":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}"}],"content":{"contentType":"group","meta":{"name":"Auth Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Auth Group","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group","summary":"List a network's auth groups","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth-group/listnetworkauthgroups","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group","summary":"Create a network auth group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"Delete a network auth group","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"List a network auth group's members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/auth-group/getnetworkauthgroup","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"Add a network auth group member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/post","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}","summary":"Update a network auth group","prefix":{"name":"put","color":"put"},"badges":[],"link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}/put","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","summary":"Remove a network auth group member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/delete","deprecated":false},{"title":"/v2/domain/{domainName}/network/{networkName}/auth-group/{groupName}/{memberID}","summary":"Update a membership","prefix":{"name":"put","color":"put"},"badges":[],"link":"/auth-group/paths/~1v2~1domain~1{domainname}~1network~1{networkname}~1auth-group~1{groupname}~1{memberid}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Certificate","link":"/certificate","routeSlug":"/certificate","items":[{"label":"Retrieve all TLS certificates and their expiration status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/certificate/listcertificates","routeSlug":"/certificate/listcertificates","metadata":{"seo":{"title":"Retrieve all TLS certificates and their expiration status","description":"Requires certificates::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCertificates","name":"Retrieve all TLS certificates and their expiration status","isWebhook":false,"pointer":"/paths/~1v2~1certificates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all TLS certificates and their expiration status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certificates::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/certificates","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/certificates","href":"/certificate/listcertificates","openApiOperationId":"listCertificates","summary":"Retrieve all TLS certificates and their expiration status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}},"schemaId":"schema_362"}],"pointer":"/paths/~1v2~1certificates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_362","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_362"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certificate/listcertificates"}],"panels":[]}]},"httpPath":"/v2/certificates"},{"label":"Upload and install a new TLS certificate for secure communications","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/certificate/paths/~1v2~1certificates/post","routeSlug":"/certificate/paths/~1v2~1certificates/post","metadata":{"seo":{"title":"Upload and install a new TLS certificate for secure communications","description":"Requires certificates::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Upload and install a new TLS certificate for secure communications","isWebhook":false,"pointer":"/paths/~1v2~1certificates/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Upload and install a new TLS certificate for secure communications","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certificates::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CertificateParts"}},"schemaId":"components/schemas/CertificateParts","pointer":"/paths/~1v2~1certificates/post/requestBody","description":"Certificate parts"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/certificates","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CertificateParts"}},"responseCodes":["200","422"],"pointer":"/v2/certificates","href":"/certificate/paths/~1v2~1certificates/post","summary":"Upload and install a new TLS certificate for secure communications"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/CertificateParts","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CertificateParts"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1certificates/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certificate/paths/~1v2~1certificates/post"}],"panels":[]}]},"httpPath":"/v2/certificates"},{"label":"Remove a TLS certificate and disable secure communications for the domain","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/certificate/paths/~1v2~1certificates~1{fqdn}/delete","routeSlug":"/certificate/paths/~1v2~1certificates~1{fqdn}/delete","metadata":{"seo":{"title":"Remove a TLS certificate and disable secure communications for the domain","description":"Requires certificates::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a TLS certificate and disable secure communications for the domain","isWebhook":false,"pointer":"/paths/~1v2~1certificates~1{fqdn}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a TLS certificate and disable secure communications for the domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certificates::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fqdn","in":"path","schemaId":"schema_240","description":"FQDN of certificate","required":true}],"pointer":"/paths/~1v2~1certificates~1{fqdn}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/certificates/{fqdn}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"fqdn","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/certificates/{fqdn}","href":"/certificate/paths/~1v2~1certificates~1{fqdn}/delete","summary":"Remove a TLS certificate and disable secure communications for the domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1certificates~1{fqdn}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certificate/paths/~1v2~1certificates~1{fqdn}/delete"}],"panels":[]}]},"httpPath":"/v2/certificates/{fqdn}"},{"label":"Replace an existing TLS certificate with an updated version","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/certificate/paths/~1v2~1certificates~1{fqdn}/put","routeSlug":"/certificate/paths/~1v2~1certificates~1{fqdn}/put","metadata":{"seo":{"title":"Replace an existing TLS certificate with an updated version","description":"Requires certificates::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Replace an existing TLS certificate with an updated version","isWebhook":false,"pointer":"/paths/~1v2~1certificates~1{fqdn}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace an existing TLS certificate with an updated version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certificates::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"fqdn","in":"path","schemaId":"schema_240","description":"FQDN of certificate","required":true}],"pointer":"/paths/~1v2~1certificates~1{fqdn}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CertificateParts"}},"schemaId":"components/schemas/CertificateParts","pointer":"/paths/~1v2~1certificates~1{fqdn}/put/requestBody","description":"Certificate parts"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/certificates/{fqdn}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"fqdn","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CertificateParts"}},"responseCodes":["200","422"],"pointer":"/v2/certificates/{fqdn}","href":"/certificate/paths/~1v2~1certificates~1{fqdn}/put","summary":"Replace an existing TLS certificate with an updated version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/CertificateParts","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CertificateParts"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1certificates~1{fqdn}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/certificate/paths/~1v2~1certificates~1{fqdn}/put"}],"panels":[]}]},"httpPath":"/v2/certificates/{fqdn}"}],"content":{"contentType":"group","meta":{"name":"Certificate"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Certificate","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/certificates/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TLS certificates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" provisioned for nodes to secure communications. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certificates::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"certificates::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to manage."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/certificates","summary":"Retrieve all TLS certificates and their expiration status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/certificate/listcertificates","deprecated":false},{"title":"/v2/certificates","summary":"Upload and install a new TLS certificate for secure communications","prefix":{"name":"post","color":"post"},"badges":[],"link":"/certificate/paths/~1v2~1certificates/post","deprecated":false},{"title":"/v2/certificates/{fqdn}","summary":"Remove a TLS certificate and disable secure communications for the domain","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/certificate/paths/~1v2~1certificates~1{fqdn}/delete","deprecated":false},{"title":"/v2/certificates/{fqdn}","summary":"Replace an existing TLS certificate with an updated version","prefix":{"name":"put","color":"put"},"badges":[],"link":"/certificate/paths/~1v2~1certificates~1{fqdn}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Group","link":"/group","routeSlug":"/group","items":[{"label":"Retrieve all user groups and their access permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/group/listgroups","routeSlug":"/group/listgroups","metadata":{"seo":{"title":"Retrieve all user groups and their access permissions","description":"Requires groups::read permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroups","name":"Retrieve all user groups and their access permissions","isWebhook":false,"pointer":"/paths/~1group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all user groups and their access permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group","href":"/group/listgroups","openApiOperationId":"listGroups","summary":"Retrieve all user groups and their access permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of groups","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363"}],"pointer":"/paths/~1group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/listgroups"}],"panels":[]}]},"httpPath":"/group"},{"label":"Create a new user group with specified access permissions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/group/paths/~1group/post","routeSlug":"/group/paths/~1group/post","metadata":{"seo":{"title":"Create a new user group with specified access permissions","description":"Requires groups::modify permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new user group with specified access permissions","isWebhook":false,"pointer":"/paths/~1group/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new user group with specified access permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Group"}},"schemaId":"components/schemas/Group","pointer":"/paths/~1group/post/requestBody","description":"The group object to be created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Group"}},"responseCodes":["200"],"pointer":"/group","href":"/group/paths/~1group/post","summary":"Create a new user group with specified access permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Group","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Group"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Group successfully created"}],"pointer":"/paths/~1group/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/paths/~1group/post"}],"panels":[]}]},"httpPath":"/group"},{"label":"Remove a user from a group and revoke associated permissions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/group/paths/~1group~1{groupid}~1members~1{email}/delete","routeSlug":"/group/paths/~1group~1{groupid}~1members~1{email}/delete","metadata":{"seo":{"title":"Remove a user from a group and revoke associated permissions","description":"Requires groups::modify permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a user from a group and revoke associated permissions","isWebhook":false,"pointer":"/paths/~1group~1{groupId}~1members~1{email}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a user from a group and revoke associated permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupId","in":"path","schemaId":"schema_240","description":"ID of the group to remove a member from","required":true},{"name":"email","in":"path","schemaId":"schema_240","description":"Email of the member to be removed","required":true}],"pointer":"/paths/~1group~1{groupId}~1members~1{email}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/group/{groupId}/members/{email}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"email","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group/{groupId}/members/{email}","href":"/group/paths/~1group~1{groupid}~1members~1{email}/delete","summary":"Remove a user from a group and revoke associated permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Member successfully removed from the group"}],"pointer":"/paths/~1group~1{groupId}~1members~1{email}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/paths/~1group~1{groupid}~1members~1{email}/delete"}],"panels":[]}]},"httpPath":"/group/{groupId}/members/{email}"},{"label":"Permanently delete a group and remove all member associations","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/group/paths/~1group~1{uid}/delete","routeSlug":"/group/paths/~1group~1{uid}/delete","metadata":{"seo":{"title":"Permanently delete a group and remove all member associations","description":"Requires groups::modify permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Permanently delete a group and remove all member associations","isWebhook":false,"pointer":"/paths/~1group~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permanently delete a group and remove all member associations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"ID of the group to delete","required":true}],"pointer":"/paths/~1group~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/group/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group/{uid}","href":"/group/paths/~1group~1{uid}/delete","summary":"Permanently delete a group and remove all member associations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Group successfully deleted"}],"pointer":"/paths/~1group~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/paths/~1group~1{uid}/delete"}],"panels":[]}]},"httpPath":"/group/{uid}"},{"label":"Retrieve detailed information about a specific group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/group/getgroup","routeSlug":"/group/getgroup","metadata":{"seo":{"title":"Retrieve detailed information about a specific group","description":"Requires groups::read permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroup","name":"Retrieve detailed information about a specific group","isWebhook":false,"pointer":"/paths/~1group~1{uid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed information about a specific group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"UID of the group to retrieve","required":true}],"pointer":"/paths/~1group~1{uid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/group/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/group/{uid}","href":"/group/getgroup","openApiOperationId":"getGroup","summary":"Retrieve detailed information about a specific group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The group object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Group"}},"schemaId":"components/schemas/Group"},{"code":"404","description":"Group does not exist"}],"pointer":"/paths/~1group~1{uid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Group","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Group"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/getgroup"}],"panels":[]}]},"httpPath":"/group/{uid}"},{"label":"List all identity providers associated with a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/group/listgroupidps","routeSlug":"/group/listgroupidps","metadata":{"seo":{"title":"List all identity providers associated with a group","description":"Requires groups::read permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroupIdps","name":"List all identity providers associated with a group","isWebhook":false,"pointer":"/paths/~1group~1{uid}~1idps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all identity providers associated with a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"UID of the group","required":true}],"pointer":"/paths/~1group~1{uid}~1idps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/group/{uid}/idps","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group/{uid}/idps","href":"/group/listgroupidps","openApiOperationId":"listGroupIdps","summary":"List all identity providers associated with a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Identity Providers","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}},"schemaId":"schema_364"}],"pointer":"/paths/~1group~1{uid}~1idps/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_364","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/listgroupidps"}],"panels":[]}]},"httpPath":"/group/{uid}/idps"},{"label":"Retrieve all users that belong to a specific group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/group/listgroupmembers","routeSlug":"/group/listgroupmembers","metadata":{"seo":{"title":"Retrieve all users that belong to a specific group","description":"Requires groups::read permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroupMembers","name":"Retrieve all users that belong to a specific group","isWebhook":false,"pointer":"/paths/~1group~1{uid}~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all users that belong to a specific group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"UID of the group","required":true}],"pointer":"/paths/~1group~1{uid}~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/group/{uid}/members","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group/{uid}/members","href":"/group/listgroupmembers","openApiOperationId":"listGroupMembers","summary":"Retrieve all users that belong to a specific group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of group members","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}},"schemaId":"schema_365"}],"pointer":"/paths/~1group~1{uid}~1members/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_365","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/listgroupmembers"}],"panels":[]}]},"httpPath":"/group/{uid}/members"},{"label":"Add a new user to a group and grant associated permissions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/group/paths/~1group~1{uid}~1members/post","routeSlug":"/group/paths/~1group~1{uid}~1members/post","metadata":{"seo":{"title":"Add a new user to a group and grant associated permissions","description":"Requires groups::modify permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a new user to a group and grant associated permissions","isWebhook":false,"pointer":"/paths/~1group~1{uid}~1members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a new user to a group and grant associated permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"ID of the group to add a member to","required":true}],"pointer":"/paths/~1group~1{uid}~1members/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupMember"}},"schemaId":"components/schemas/GroupMember","pointer":"/paths/~1group~1{uid}~1members/post/requestBody","description":"The group member object to be added"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/group/{uid}/members","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GroupMember"}},"responseCodes":["200"],"pointer":"/group/{uid}/members","href":"/group/paths/~1group~1{uid}~1members/post","summary":"Add a new user to a group and grant associated permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/GroupMember","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupMember"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Member successfully added to the group"}],"pointer":"/paths/~1group~1{uid}~1members/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group/paths/~1group~1{uid}~1members/post"}],"panels":[]}]},"httpPath":"/group/{uid}/members"}],"content":{"contentType":"group","meta":{"name":"Group"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/group","summary":"Retrieve all user groups and their access permissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group/listgroups","deprecated":false},{"title":"/group","summary":"Create a new user group with specified access permissions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group/paths/~1group/post","deprecated":false},{"title":"/group/{groupId}/members/{email}","summary":"Remove a user from a group and revoke associated permissions","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/group/paths/~1group~1{groupid}~1members~1{email}/delete","deprecated":false},{"title":"/group/{uid}","summary":"Permanently delete a group and remove all member associations","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/group/paths/~1group~1{uid}/delete","deprecated":false},{"title":"/group/{uid}","summary":"Retrieve detailed information about a specific group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group/getgroup","deprecated":false},{"title":"/group/{uid}/idps","summary":"List all identity providers associated with a group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group/listgroupidps","deprecated":false},{"title":"/group/{uid}/members","summary":"Retrieve all users that belong to a specific group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/group/listgroupmembers","deprecated":false},{"title":"/group/{uid}/members","summary":"Add a new user to a group and grant associated permissions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group/paths/~1group~1{uid}~1members/post","deprecated":false}]}]}]}]}},{"type":"group","label":"HTTPExporter","link":"/httpexporter","routeSlug":"/httpexporter","items":[{"label":"Retrieve HTTP-specific configuration for a telemetry data exporter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/httpexporter/gethttpobservabilityexporter","routeSlug":"/httpexporter/gethttpobservabilityexporter","metadata":{"seo":{"title":"Retrieve HTTP-specific configuration for a telemetry data exporter","description":"Requires observability::read permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getHttpObservabilityExporter","name":"Retrieve HTTP-specific configuration for a telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve HTTP-specific configuration for a telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/observability-exporter/http/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/observability-exporter/http/{id}","href":"/httpexporter/gethttpobservabilityexporter","openApiOperationId":"getHttpObservabilityExporter","summary":"Retrieve HTTP-specific configuration for a telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An observability exporter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}},"schemaId":"components/schemas/HTTPExporter"},{"code":"404","description":"Observability exporter not found"}],"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HTTPExporter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/httpexporter/gethttpobservabilityexporter"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/http/{id}"},{"label":"Modify HTTP-specific settings for a telemetry data exporter","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/httpexporter/paths/~1v2~1observability-exporter~1http~1{id}/put","routeSlug":"/httpexporter/paths/~1v2~1observability-exporter~1http~1{id}/put","metadata":{"seo":{"title":"Modify HTTP-specific settings for a telemetry data exporter","description":"Requires observability::modify permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify HTTP-specific settings for a telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify HTTP-specific settings for a telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}},"schemaId":"components/schemas/HTTPExporter","pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/put/requestBody","description":"HTTP Exporter"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/observability-exporter/http/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}},"responseCodes":["200","404","422"],"pointer":"/v2/observability-exporter/http/{id}","href":"/httpexporter/paths/~1v2~1observability-exporter~1http~1{id}/put","summary":"Modify HTTP-specific settings for a telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/HTTPExporter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Observability exporter not found"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/httpexporter/paths/~1v2~1observability-exporter~1http~1{id}/put"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/http/{id}"}],"content":{"contentType":"group","meta":{"name":"HTTPExporter"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"HTTPExporter","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generic HTTP observability exporter for forwarding telemetry to any OpenTelemetry-compatible HTTP endpoint. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to configure. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature flag."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/observability-exporter/http/{id}","summary":"Retrieve HTTP-specific configuration for a telemetry data exporter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/httpexporter/gethttpobservabilityexporter","deprecated":false},{"title":"/v2/observability-exporter/http/{id}","summary":"Modify HTTP-specific settings for a telemetry data exporter","prefix":{"name":"put","color":"put"},"badges":[],"link":"/httpexporter/paths/~1v2~1observability-exporter~1http~1{id}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"IDP","link":"/idp","routeSlug":"/idp","items":[{"label":"Retrieve all configured identity providers for user authentication","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/idp/listidps","routeSlug":"/idp/listidps","metadata":{"seo":{"title":"Retrieve all configured identity providers for user authentication","description":"Retrieve all configured identity providers for user authentication"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listIdps","name":"Retrieve all configured identity providers for user authentication","isWebhook":false,"pointer":"/paths/~1v2~1idp/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all configured identity providers for user authentication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/idp","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/idp","href":"/idp/listidps","openApiOperationId":"listIdps","summary":"Retrieve all configured identity providers for user authentication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}},"schemaId":"schema_366"}],"pointer":"/paths/~1v2~1idp/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_366","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_366"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/idp/listidps"}],"panels":[]}]},"httpPath":"/v2/idp"},{"label":"Configure a new identity provider for external user authentication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/idp/paths/~1v2~1idp/post","routeSlug":"/idp/paths/~1v2~1idp/post","metadata":{"seo":{"title":"Configure a new identity provider for external user authentication","description":"Configure a new identity provider for external user authentication"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure a new identity provider for external user authentication","isWebhook":false,"pointer":"/paths/~1v2~1idp/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure a new identity provider for external user authentication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityProviderUpdateModel"}},"schemaId":"components/schemas/IdentityProviderUpdateModel","pointer":"/paths/~1v2~1idp/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/idp","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IdentityProviderUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/idp","href":"/idp/paths/~1v2~1idp/post","summary":"Configure a new identity provider for external user authentication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/IdentityProviderUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityProviderUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1idp/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/idp/paths/~1v2~1idp/post"}],"panels":[]}]},"httpPath":"/v2/idp"},{"label":"Configure OpenID Connect authentication settings for an identity provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/idp/paths/~1v2~1idp~1openid~1{idpid}/put","routeSlug":"/idp/paths/~1v2~1idp~1openid~1{idpid}/put","metadata":{"seo":{"title":"Configure OpenID Connect authentication settings for an identity provider","description":"Requires identity-providers::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure OpenID Connect authentication settings for an identity provider","isWebhook":false,"pointer":"/paths/~1v2~1idp~1openid~1{idpID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure OpenID Connect authentication settings for an identity provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-providers::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"idpID","in":"path","schemaId":"schema_240","description":"IDP ID","required":true}],"pointer":"/paths/~1v2~1idp~1openid~1{idpID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OpenIDConfig"}},"schemaId":"components/schemas/OpenIDConfig","pointer":"/paths/~1v2~1idp~1openid~1{idpID}/put/requestBody","description":"OpenID config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/idp/openid/{idpID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"idpID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OpenIDConfig"}},"responseCodes":["200","422"],"pointer":"/v2/idp/openid/{idpID}","href":"/idp/paths/~1v2~1idp~1openid~1{idpid}/put","summary":"Configure OpenID Connect authentication settings for an identity provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/OpenIDConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OpenIDConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1idp~1openid~1{idpID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/idp/paths/~1v2~1idp~1openid~1{idpid}/put"}],"panels":[]}]},"httpPath":"/v2/idp/openid/{idpID}"},{"label":"Configure SAML 2.0 authentication settings for an identity provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/idp/paths/~1v2~1idp~1saml~1{idpid}/put","routeSlug":"/idp/paths/~1v2~1idp~1saml~1{idpid}/put","metadata":{"seo":{"title":"Configure SAML 2.0 authentication settings for an identity provider","description":"Requires identity-providers::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure SAML 2.0 authentication settings for an identity provider","isWebhook":false,"pointer":"/paths/~1v2~1idp~1saml~1{idpID}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure SAML 2.0 authentication settings for an identity provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-providers::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"idpID","in":"path","schemaId":"schema_240","description":"IDP ID","required":true}],"pointer":"/paths/~1v2~1idp~1saml~1{idpID}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SAMLConfig"}},"schemaId":"components/schemas/SAMLConfig","pointer":"/paths/~1v2~1idp~1saml~1{idpID}/put/requestBody","description":"SAML config"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/idp/saml/{idpID}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"idpID","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SAMLConfig"}},"responseCodes":["200","422"],"pointer":"/v2/idp/saml/{idpID}","href":"/idp/paths/~1v2~1idp~1saml~1{idpid}/put","summary":"Configure SAML 2.0 authentication settings for an identity provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/SAMLConfig","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SAMLConfig"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1idp~1saml~1{idpID}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/idp/paths/~1v2~1idp~1saml~1{idpid}/put"}],"panels":[]}]},"httpPath":"/v2/idp/saml/{idpID}"},{"label":"Remove an identity provider and disable external authentication","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/idp/paths/~1v2~1idp~1{uid}/delete","routeSlug":"/idp/paths/~1v2~1idp~1{uid}/delete","metadata":{"seo":{"title":"Remove an identity provider and disable external authentication","description":"Remove an identity provider and disable external authentication"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove an identity provider and disable external authentication","isWebhook":false,"pointer":"/paths/~1v2~1idp~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an identity provider and disable external authentication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Identity provider UID","required":true}],"pointer":"/paths/~1v2~1idp~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/idp/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/idp/{uid}","href":"/idp/paths/~1v2~1idp~1{uid}/delete","summary":"Remove an identity provider and disable external authentication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1idp~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/idp/paths/~1v2~1idp~1{uid}/delete"}],"panels":[]}]},"httpPath":"/v2/idp/{uid}"},{"label":"Retrieve configuration details for a specific identity provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/idp/getidp","routeSlug":"/idp/getidp","metadata":{"seo":{"title":"Retrieve configuration details for a specific identity provider","description":"Retrieve configuration details for a specific identity provider"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getIdp","name":"Retrieve configuration details for a specific identity provider","isWebhook":false,"pointer":"/paths/~1v2~1idp~1{uid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve configuration details for a specific identity provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Identity provider UID","required":true}],"pointer":"/paths/~1v2~1idp~1{uid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/idp/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/idp/{uid}","href":"/idp/getidp","openApiOperationId":"getIdp","summary":"Retrieve configuration details for a specific identity provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityProviderModel"}},"schemaId":"components/schemas/IdentityProviderModel"}],"pointer":"/paths/~1v2~1idp~1{uid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/IdentityProviderModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/IdentityProviderModel"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/idp/getidp"}],"panels":[]}]},"httpPath":"/v2/idp/{uid}"},{"label":"Modify authentication settings for an existing identity provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/idp/paths/~1v2~1idp~1{uid}/put","routeSlug":"/idp/paths/~1v2~1idp~1{uid}/put","metadata":{"seo":{"title":"Modify authentication settings for an existing identity provider","description":"Modify authentication settings for an existing identity provider"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify authentication settings for an existing identity provider","isWebhook":false,"pointer":"/paths/~1v2~1idp~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify authentication settings for an existing identity provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Identity provider UID","required":true}],"pointer":"/paths/~1v2~1idp~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityProviderUpdateModel"}},"schemaId":"components/schemas/IdentityProviderUpdateModel","pointer":"/paths/~1v2~1idp~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/idp/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/IdentityProviderUpdateModel"}},"responseCodes":["200","422"],"pointer":"/v2/idp/{uid}","href":"/idp/paths/~1v2~1idp~1{uid}/put","summary":"Modify authentication settings for an existing identity provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/IdentityProviderUpdateModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/IdentityProviderUpdateModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1idp~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/idp/paths/~1v2~1idp~1{uid}/put"}],"panels":[]}]},"httpPath":"/v2/idp/{uid}"}],"content":{"contentType":"group","meta":{"name":"IDP"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IDP","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/idps/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity provider"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" integrations (Okta, Azure AD, Google, SAML, OIDC) for SSO authentication and user/group synchronization. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity-providers::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/idp","summary":"Retrieve all configured identity providers for user authentication","prefix":{"name":"get","color":"get"},"badges":[],"link":"/idp/listidps","deprecated":false},{"title":"/v2/idp","summary":"Configure a new identity provider for external user authentication","prefix":{"name":"post","color":"post"},"badges":[],"link":"/idp/paths/~1v2~1idp/post","deprecated":false},{"title":"/v2/idp/openid/{idpID}","summary":"Configure OpenID Connect authentication settings for an identity provider","prefix":{"name":"put","color":"put"},"badges":[],"link":"/idp/paths/~1v2~1idp~1openid~1{idpid}/put","deprecated":false},{"title":"/v2/idp/saml/{idpID}","summary":"Configure SAML 2.0 authentication settings for an identity provider","prefix":{"name":"put","color":"put"},"badges":[],"link":"/idp/paths/~1v2~1idp~1saml~1{idpid}/put","deprecated":false},{"title":"/v2/idp/{uid}","summary":"Remove an identity provider and disable external authentication","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/idp/paths/~1v2~1idp~1{uid}/delete","deprecated":false},{"title":"/v2/idp/{uid}","summary":"Retrieve configuration details for a specific identity provider","prefix":{"name":"get","color":"get"},"badges":[],"link":"/idp/getidp","deprecated":false},{"title":"/v2/idp/{uid}","summary":"Modify authentication settings for an existing identity provider","prefix":{"name":"put","color":"put"},"badges":[],"link":"/idp/paths/~1v2~1idp~1{uid}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"ObservabilityExporter","link":"/observabilityexporter","routeSlug":"/observabilityexporter","items":[{"label":"Retrieve all configured telemetry data exporters for external monitoring systems","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/observabilityexporter/listobservabilityexporters","routeSlug":"/observabilityexporter/listobservabilityexporters","metadata":{"seo":{"title":"Retrieve all configured telemetry data exporters for external monitoring systems","description":"Requires observability::read permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listObservabilityExporters","name":"Retrieve all configured telemetry data exporters for external monitoring systems","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all configured telemetry data exporters for external monitoring systems","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/observability-exporter","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/observability-exporter","href":"/observabilityexporter/listobservabilityexporters","openApiOperationId":"listObservabilityExporters","summary":"Retrieve all configured telemetry data exporters for external monitoring systems"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of observability exporters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}},"schemaId":"schema_367"}],"pointer":"/paths/~1v2~1observability-exporter/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_367","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_367"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/observabilityexporter/listobservabilityexporters"}],"panels":[]}]},"httpPath":"/v2/observability-exporter"},{"label":"Configure a new telemetry data exporter for external monitoring integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/observabilityexporter/paths/~1v2~1observability-exporter/post","routeSlug":"/observabilityexporter/paths/~1v2~1observability-exporter/post","metadata":{"seo":{"title":"Configure a new telemetry data exporter for external monitoring integration","description":"Requires observability::modify permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Configure a new telemetry data exporter for external monitoring integration","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure a new telemetry data exporter for external monitoring integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ObservabilityExporter"}},"schemaId":"components/schemas/ObservabilityExporter","pointer":"/paths/~1v2~1observability-exporter/post/requestBody","description":"Observability Exporter"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/observability-exporter","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ObservabilityExporter"}},"responseCodes":["200","422"],"pointer":"/v2/observability-exporter","href":"/observabilityexporter/paths/~1v2~1observability-exporter/post","summary":"Configure a new telemetry data exporter for external monitoring integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ObservabilityExporter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ObservabilityExporter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Observability exporter created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1observability-exporter/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}}},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/observabilityexporter/paths/~1v2~1observability-exporter/post"}],"panels":[]}]},"httpPath":"/v2/observability-exporter"},{"label":"Retrieve configuration details for a specific telemetry data exporter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/observabilityexporter/getobservabilityexporter","routeSlug":"/observabilityexporter/getobservabilityexporter","metadata":{"seo":{"title":"Retrieve configuration details for a specific telemetry data exporter","description":"Requires observability::read permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getObservabilityExporter","name":"Retrieve configuration details for a specific telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve configuration details for a specific telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/observability-exporter/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/observability-exporter/{id}","href":"/observabilityexporter/getobservabilityexporter","openApiOperationId":"getObservabilityExporter","summary":"Retrieve configuration details for a specific telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An observability exporter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ObservabilityExporter"}},"schemaId":"components/schemas/ObservabilityExporter"},{"code":"404","description":"Observability exporter not found"}],"pointer":"/paths/~1v2~1observability-exporter~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ObservabilityExporter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ObservabilityExporter"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/observabilityexporter/getobservabilityexporter"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/{id}"},{"label":"Modify settings for an existing telemetry data exporter","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/put","routeSlug":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/put","metadata":{"seo":{"title":"Modify settings for an existing telemetry data exporter","description":"Requires observability::modify permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify settings for an existing telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify settings for an existing telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ObservabilityExporter"}},"schemaId":"components/schemas/ObservabilityExporter","pointer":"/paths/~1v2~1observability-exporter~1{id}/put/requestBody","description":"Observability Exporter"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/observability-exporter/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/ObservabilityExporter"}},"responseCodes":["200","404","422"],"pointer":"/v2/observability-exporter/{id}","href":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/put","summary":"Modify settings for an existing telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/ObservabilityExporter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ObservabilityExporter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Observability exporter not found"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1observability-exporter~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/put"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/{id}"},{"label":"Remove a telemetry data exporter and stop external monitoring integration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/delete","routeSlug":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/delete","metadata":{"seo":{"title":"Remove a telemetry data exporter and stop external monitoring integration","description":"Requires observability::modify permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a telemetry data exporter and stop external monitoring integration","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a telemetry data exporter and stop external monitoring integration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/observability-exporter/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/observability-exporter/{id}","href":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/delete","summary":"Remove a telemetry data exporter and stop external monitoring integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1observability-exporter~1{id}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/delete"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/{id}"},{"label":"Retrieve Splunk-specific configuration for a telemetry data exporter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/observabilityexporter/getsplunkobservabilityexporter","routeSlug":"/observabilityexporter/getsplunkobservabilityexporter","metadata":{"seo":{"title":"Retrieve Splunk-specific configuration for a telemetry data exporter","description":"Requires observability::read permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSplunkObservabilityExporter","name":"Retrieve Splunk-specific configuration for a telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Splunk-specific configuration for a telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/observability-exporter/splunk/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/observability-exporter/splunk/{id}","href":"/observabilityexporter/getsplunkobservabilityexporter","openApiOperationId":"getSplunkObservabilityExporter","summary":"Retrieve Splunk-specific configuration for a telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An observability exporter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}},"schemaId":"components/schemas/SplunkExporter"},{"code":"404","description":"Observability exporter not found"}],"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SplunkExporter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/observabilityexporter/getsplunkobservabilityexporter"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/splunk/{id}"},{"label":"Modify Splunk-specific settings for a telemetry data exporter","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/observabilityexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put","routeSlug":"/observabilityexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put","metadata":{"seo":{"title":"Modify Splunk-specific settings for a telemetry data exporter","description":"Requires observability::modify permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify Splunk-specific settings for a telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify Splunk-specific settings for a telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}},"schemaId":"components/schemas/SplunkExporter","pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/put/requestBody","description":"Splunk Exporter"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/observability-exporter/splunk/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}},"responseCodes":["200","404","422"],"pointer":"/v2/observability-exporter/splunk/{id}","href":"/observabilityexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put","summary":"Modify Splunk-specific settings for a telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/SplunkExporter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Observability exporter not found"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/observabilityexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/splunk/{id}"},{"label":"Retrieve HTTP-specific configuration for a telemetry data exporter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/observabilityexporter/gethttpobservabilityexporter","routeSlug":"/observabilityexporter/gethttpobservabilityexporter","metadata":{"seo":{"title":"Retrieve HTTP-specific configuration for a telemetry data exporter","description":"Requires observability::read permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getHttpObservabilityExporter","name":"Retrieve HTTP-specific configuration for a telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve HTTP-specific configuration for a telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/observability-exporter/http/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/observability-exporter/http/{id}","href":"/observabilityexporter/gethttpobservabilityexporter","openApiOperationId":"getHttpObservabilityExporter","summary":"Retrieve HTTP-specific configuration for a telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An observability exporter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}},"schemaId":"components/schemas/HTTPExporter"},{"code":"404","description":"Observability exporter not found"}],"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/HTTPExporter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/observabilityexporter/gethttpobservabilityexporter"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/http/{id}"},{"label":"Modify HTTP-specific settings for a telemetry data exporter","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/observabilityexporter/paths/~1v2~1observability-exporter~1http~1{id}/put","routeSlug":"/observabilityexporter/paths/~1v2~1observability-exporter~1http~1{id}/put","metadata":{"seo":{"title":"Modify HTTP-specific settings for a telemetry data exporter","description":"Requires observability::modify permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify HTTP-specific settings for a telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify HTTP-specific settings for a telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}},"schemaId":"components/schemas/HTTPExporter","pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/put/requestBody","description":"HTTP Exporter"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/observability-exporter/http/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}},"responseCodes":["200","404","422"],"pointer":"/v2/observability-exporter/http/{id}","href":"/observabilityexporter/paths/~1v2~1observability-exporter~1http~1{id}/put","summary":"Modify HTTP-specific settings for a telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/HTTPExporter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/HTTPExporter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Observability exporter not found"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1observability-exporter~1http~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/observabilityexporter/paths/~1v2~1observability-exporter~1http~1{id}/put"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/http/{id}"}],"content":{"contentType":"group","meta":{"name":"ObservabilityExporter"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ObservabilityExporter","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/observability/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Observability exporters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configure telemetry data forwarding to external monitoring systems (Splunk, HTTP endpoints) via OpenTelemetry. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to configure. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature flag."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/observability-exporter","summary":"Retrieve all configured telemetry data exporters for external monitoring systems","prefix":{"name":"get","color":"get"},"badges":[],"link":"/observabilityexporter/listobservabilityexporters","deprecated":false},{"title":"/v2/observability-exporter","summary":"Configure a new telemetry data exporter for external monitoring integration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/observabilityexporter/paths/~1v2~1observability-exporter/post","deprecated":false},{"title":"/v2/observability-exporter/{id}","summary":"Retrieve configuration details for a specific telemetry data exporter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/observabilityexporter/getobservabilityexporter","deprecated":false},{"title":"/v2/observability-exporter/{id}","summary":"Modify settings for an existing telemetry data exporter","prefix":{"name":"put","color":"put"},"badges":[],"link":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/put","deprecated":false},{"title":"/v2/observability-exporter/{id}","summary":"Remove a telemetry data exporter and stop external monitoring integration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/observabilityexporter/paths/~1v2~1observability-exporter~1{id}/delete","deprecated":false},{"title":"/v2/observability-exporter/splunk/{id}","summary":"Retrieve Splunk-specific configuration for a telemetry data exporter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/observabilityexporter/getsplunkobservabilityexporter","deprecated":false},{"title":"/v2/observability-exporter/splunk/{id}","summary":"Modify Splunk-specific settings for a telemetry data exporter","prefix":{"name":"put","color":"put"},"badges":[],"link":"/observabilityexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put","deprecated":false},{"title":"/v2/observability-exporter/http/{id}","summary":"Retrieve HTTP-specific configuration for a telemetry data exporter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/observabilityexporter/gethttpobservabilityexporter","deprecated":false},{"title":"/v2/observability-exporter/http/{id}","summary":"Modify HTTP-specific settings for a telemetry data exporter","prefix":{"name":"put","color":"put"},"badges":[],"link":"/observabilityexporter/paths/~1v2~1observability-exporter~1http~1{id}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Org","link":"/org","routeSlug":"/org","items":[{"label":"Retrieve organization details and configuration settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/org/getorg","routeSlug":"/org/getorg","metadata":{"seo":{"title":"Retrieve organization details and configuration settings","description":"Retrieve organization details and configuration settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrg","name":"Retrieve organization details and configuration settings","isWebhook":false,"pointer":"/paths/~1org~1mine/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve organization details and configuration settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/org/mine","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/org/mine","href":"/org/getorg","openApiOperationId":"getOrg","summary":"Retrieve organization details and configuration settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrgModel"}},"schemaId":"components/schemas/OrgModel"},{"code":"404","description":"Org not found"}],"pointer":"/paths/~1org~1mine/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrgModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrgModel"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/org/getorg"}],"panels":[]}]},"httpPath":"/org/mine"}],"content":{"contentType":"group","meta":{"name":"Org"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Org","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization-level settings including "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/support/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"support requests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", notification preferences, and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/support/documents/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"shared documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orgs::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/org/mine","summary":"Retrieve organization details and configuration settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/org/getorg","deprecated":false}]}]}]}]}},{"type":"group","label":"Order","link":"/order","routeSlug":"/order","items":[{"label":"Retrieve all hardware provisioning orders and their current status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/listorders","routeSlug":"/order/listorders","metadata":{"seo":{"title":"Retrieve all hardware provisioning orders and their current status","description":"Search and list hardware provisioning orders visible to the caller.Results are paginated; use page and perPage to iterate andx-total-count for the total matching set."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrders","name":"Retrieve all hardware provisioning orders and their current status","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all hardware provisioning orders and their current status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search and list hardware provisioning orders visible to the caller."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are paginated; use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"perPage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to iterate and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-total-count"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the total matching set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Responses from this endpoint are not fully hydrated (for example,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"node details are omitted)."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"assignee","in":"query","schemaId":"schema_240","description":"Filter by assigned Trustgrid user"},{"name":"creator","in":"query","schemaId":"schema_240","description":"Filter by order creator user ID"},{"name":"projectID","in":"query","schemaId":"schema_240","description":"Filter by project ID"},{"name":"priority","in":"query","schemaId":"schema_369","description":"Filter by priority"},{"name":"status","in":"query","schemaId":"schema_370","description":"Filter by status"},{"name":"excludeStatus","in":"query","schemaId":"schema_370","description":"Exclude orders with this status"},{"name":"transition-status","in":"query","schemaId":"schema_240","description":"Status value to count transitions for"},{"name":"transition-from","in":"query","schemaId":"schema_327","description":"Start of transition window (unix timestamp)"},{"name":"transition-to","in":"query","schemaId":"schema_327","description":"End of transition window (unix timestamp; defaults to now)"},{"name":"label","in":"query","schemaId":"schema_240","description":"Filter by label"},{"name":"q","in":"query","schemaId":"schema_240","description":"Free-text search across the order"},{"name":"page","in":"query","schemaId":"schema_371","description":"Page number"},{"name":"perPage","in":"query","schemaId":"schema_371","description":"Number of orders per page"},{"name":"sort","in":"query","schemaId":"schema_240","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sort field and direction (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt:desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"name":"createdAfter","in":"query","schemaId":"schema_372","description":"Include orders created at or after this RFC3339 timestamp"},{"name":"createdBefore","in":"query","schemaId":"schema_372","description":"Include orders created before this RFC3339 timestamp"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/provisioning/api/v1/orders","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"assignee","in":"query","schemaId":"schema_240"},{"name":"creator","in":"query","schemaId":"schema_240"},{"name":"projectID","in":"query","schemaId":"schema_240"},{"name":"priority","in":"query","schemaId":"components/schemas/OrderPriority"},{"name":"status","in":"query","schemaId":"components/schemas/OrderStatus"},{"name":"excludeStatus","in":"query","schemaId":"components/schemas/OrderStatus"},{"name":"transition-status","in":"query","schemaId":"schema_240"},{"name":"transition-from","in":"query","schemaId":"schema_327"},{"name":"transition-to","in":"query","schemaId":"schema_327"},{"name":"label","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"},{"name":"page","in":"query","schemaId":"schema_371"},{"name":"perPage","in":"query","schemaId":"schema_371"},{"name":"sort","in":"query","schemaId":"schema_240"},{"name":"createdAfter","in":"query","schemaId":"schema_372"},{"name":"createdBefore","in":"query","schemaId":"schema_372"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/provisioning/api/v1/orders","href":"/order/listorders","openApiOperationId":"listOrders","summary":"Retrieve all hardware provisioning orders and their current status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373"}},"schemaId":"schema_373","headers":{"x-total-count":{"description":"Total number of orders matching the query","schema":{"type":"integer"}}},"headerSchemaId":"schema_374"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_373","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_373"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/listorders"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders"},{"label":"Submit a new hardware provisioning order for appliances or agents","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/createorder","routeSlug":"/order/createorder","metadata":{"seo":{"title":"Submit a new hardware provisioning order for appliances or agents","description":"Creates a new provisioning order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrder","name":"Submit a new hardware provisioning order for appliances or agents","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Submit a new hardware provisioning order for appliances or agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new provisioning order."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderModel"}},"schemaId":"components/schemas/OrderModel","pointer":"/paths/~1provisioning~1api~1v1~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/provisioning/api/v1/orders","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderModel"}},"responseCodes":["200","422"],"pointer":"/provisioning/api/v1/orders","href":"/order/createorder","openApiOperationId":"createOrder","summary":"Submit a new hardware provisioning order for appliances or agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/OrderModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderModel"}},"schemaId":"components/schemas/OrderModel"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderModel"}}},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/createorder"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders"},{"label":"List users who have created orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/listordercreators","routeSlug":"/order/listordercreators","metadata":{"seo":{"title":"List users who have created orders","description":"Returns user IDs of order creators visible to the caller."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrderCreators","name":"List users who have created orders","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1creators/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List users who have created orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns user IDs of order creators visible to the caller."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/provisioning/api/v1/orders/creators","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/provisioning/api/v1/orders/creators","href":"/order/listordercreators","openApiOperationId":"listOrderCreators","summary":"List users who have created orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}},"schemaId":"schema_243"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1creators/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_243","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/listordercreators"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/creators"},{"label":"List order labels visible to the caller","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/listorderlabels","routeSlug":"/order/listorderlabels","metadata":{"seo":{"title":"List order labels visible to the caller","description":"Returns the distinct labels used on orders the caller can see."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrderLabels","name":"List order labels visible to the caller","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List order labels visible to the caller","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the distinct labels used on orders the caller can see."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/provisioning/api/v1/orders/labels","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/provisioning/api/v1/orders/labels","href":"/order/listorderlabels","openApiOperationId":"listOrderLabels","summary":"List order labels visible to the caller"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}},"schemaId":"schema_243"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1labels/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_243","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/listorderlabels"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/labels"},{"label":"Count orders grouped by status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/getorderstatuscounts","routeSlug":"/order/getorderstatuscounts","metadata":{"seo":{"title":"Count orders grouped by status","description":"Returns a map of status names to order counts for the filtered query."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderStatusCounts","name":"Count orders grouped by status","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1status-counts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Count orders grouped by status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a map of status names to order counts for the filtered query."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"createdAfter","in":"query","schemaId":"schema_372","description":"Include orders created at or after this RFC3339 timestamp"},{"name":"createdBefore","in":"query","schemaId":"schema_372","description":"Include orders created before this RFC3339 timestamp"},{"name":"assignee","in":"query","schemaId":"schema_240","description":"Filter by assigned Trustgrid user"},{"name":"creator","in":"query","schemaId":"schema_240","description":"Filter by order creator user ID"},{"name":"projectID","in":"query","schemaId":"schema_240","description":"Filter by project ID"},{"name":"priority","in":"query","schemaId":"schema_369","description":"Filter by priority"},{"name":"status","in":"query","schemaId":"schema_370","description":"Filter by status"},{"name":"excludeStatus","in":"query","schemaId":"schema_370","description":"Exclude orders with this status"},{"name":"transition-status","in":"query","schemaId":"schema_240","description":"Status value to count transitions for"},{"name":"transition-from","in":"query","schemaId":"schema_327","description":"Start of transition window (unix timestamp)"},{"name":"transition-to","in":"query","schemaId":"schema_327","description":"End of transition window (unix timestamp; defaults to now)"},{"name":"label","in":"query","schemaId":"schema_240","description":"Filter by label"},{"name":"q","in":"query","schemaId":"schema_240","description":"Free-text search across the order"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1status-counts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/provisioning/api/v1/orders/status-counts","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[{"name":"createdAfter","in":"query","schemaId":"schema_372"},{"name":"createdBefore","in":"query","schemaId":"schema_372"},{"name":"assignee","in":"query","schemaId":"schema_240"},{"name":"creator","in":"query","schemaId":"schema_240"},{"name":"projectID","in":"query","schemaId":"schema_240"},{"name":"priority","in":"query","schemaId":"components/schemas/OrderPriority"},{"name":"status","in":"query","schemaId":"components/schemas/OrderStatus"},{"name":"excludeStatus","in":"query","schemaId":"components/schemas/OrderStatus"},{"name":"transition-status","in":"query","schemaId":"schema_240"},{"name":"transition-from","in":"query","schemaId":"schema_327"},{"name":"transition-to","in":"query","schemaId":"schema_327"},{"name":"label","in":"query","schemaId":"schema_240"},{"name":"q","in":"query","schemaId":"schema_240"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/provisioning/api/v1/orders/status-counts","href":"/order/getorderstatuscounts","openApiOperationId":"getOrderStatusCounts","summary":"Count orders grouped by status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}},"schemaId":"schema_375"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1status-counts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_375","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_375"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/getorderstatuscounts"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/status-counts"},{"label":"Create an order from a sales/webhook payload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/createorderwebhook","routeSlug":"/order/createorderwebhook","metadata":{"seo":{"title":"Create an order from a sales/webhook payload","description":"Creates a new order from a flat webhook-style payload. The flat networkfields are translated into nodes and NATs."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrderWebhook","name":"Create an order from a sales/webhook payload","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1webhook/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order from a sales/webhook payload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new order from a flat webhook-style payload. The flat network"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fields are translated into nodes and NATs."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWebhookInput"}},"schemaId":"components/schemas/OrderWebhookInput","pointer":"/paths/~1provisioning~1api~1v1~1orders~1webhook/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/provisioning/api/v1/orders/webhook","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderWebhookInput"}},"responseCodes":["200","422"],"pointer":"/provisioning/api/v1/orders/webhook","href":"/order/createorderwebhook","openApiOperationId":"createOrderWebhook","summary":"Create an order from a sales/webhook payload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/OrderWebhookInput","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWebhookInput"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1webhook/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}}},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/createorderwebhook"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/webhook"},{"label":"Retrieve detailed information about a specific provisioning order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/getorder","routeSlug":"/order/getorder","metadata":{"seo":{"title":"Retrieve detailed information about a specific provisioning order","description":"Returns the fully hydrated order, including node details, comments,attachments, and history."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrder","name":"Retrieve detailed information about a specific provisioning order","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed information about a specific provisioning order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the fully hydrated order, including node details, comments,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attachments, and history."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Order UID","required":true}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/provisioning/api/v1/orders/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/provisioning/api/v1/orders/{uid}","href":"/order/getorder","openApiOperationId":"getOrder","summary":"Retrieve detailed information about a specific provisioning order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderModel"}},"schemaId":"components/schemas/OrderModel"},{"code":"404","description":"Order not found"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderModel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderModel"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/getorder"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/{uid}"},{"label":"Modify the details and requirements of an existing provisioning order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/updateorder","routeSlug":"/order/updateorder","metadata":{"seo":{"title":"Modify the details and requirements of an existing provisioning order","description":"Updates an existing order. The request body accepts the same fields asorder creation, except fields that are immutable (creator, org, UID,comments)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrder","name":"Modify the details and requirements of an existing provisioning order","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify the details and requirements of an existing provisioning order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an existing order. The request body accepts the same fields as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order creation, except fields that are immutable (creator, org, UID,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"comments)."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Order UID","required":true}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderModel"}},"schemaId":"components/schemas/OrderModel","pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/provisioning/api/v1/orders/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderModel"}},"responseCodes":["200","404","422"],"pointer":"/provisioning/api/v1/orders/{uid}","href":"/order/updateorder","openApiOperationId":"updateOrder","summary":"Modify the details and requirements of an existing provisioning order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/OrderModel","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderModel"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Order not found"},{"code":"422","description":"Validation Failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/updateorder"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/{uid}"},{"label":"Attach a file to an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/addorderattachment","routeSlug":"/order/addorderattachment","metadata":{"seo":{"title":"Attach a file to an order","description":"Uploads one or more files and associates them with the order asattachments."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addOrderAttachment","name":"Attach a file to an order","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1attachment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach a file to an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Uploads one or more files and associates them with the order as"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attachments."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Order UID","required":true}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1attachment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_376"}},"schemaId":"schema_376","pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1attachment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/provisioning/api/v1/orders/{uid}/attachment","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"multipart/form-data":{"schemaId":"schema_376"}},"responseCodes":["200"],"pointer":"/provisioning/api/v1/orders/{uid}/attachment","href":"/order/addorderattachment","openApiOperationId":"addOrderAttachment","summary":"Attach a file to an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_376","mediaTypes":["multipart/form-data"],"mediaTypeSchemas":{"multipart/form-data":{"schemaId":"schema_376"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1attachment/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/addorderattachment"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/{uid}/attachment"},{"label":"Clone an existing order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/cloneorder","routeSlug":"/order/cloneorder","metadata":{"seo":{"title":"Clone an existing order","description":"Creates a new order as a copy of the given order. The new order has afresh UID, order number, and createdAt; shipping and clone metadataare cleared."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cloneOrder","name":"Clone an existing order","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1clone/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clone an existing order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new order as a copy of the given order. The new order has a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fresh UID, order number, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; shipping and clone metadata"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"are cleared."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Order UID","required":true}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1clone/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/provisioning/api/v1/orders/{uid}/clone","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/provisioning/api/v1/orders/{uid}/clone","href":"/order/cloneorder","openApiOperationId":"cloneOrder","summary":"Clone an existing order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}},"schemaId":"schema_368"},{"code":"404","description":"Order not found"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1clone/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_368","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_368"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/cloneorder"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/{uid}/clone"},{"label":"Add a note or comment to track order progress and communication","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/addordercomment","routeSlug":"/order/addordercomment","metadata":{"seo":{"title":"Add a note or comment to track order progress and communication","description":"Adds a comment to the order, attributed to the authenticated user."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addOrderComment","name":"Add a note or comment to track order progress and communication","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1comment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a note or comment to track order progress and communication","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a comment to the order, attributed to the authenticated user."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::comment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Order UID","required":true}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_377"}},"schemaId":"schema_377","pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1comment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/provisioning/api/v1/orders/{uid}/comment","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_377"}},"responseCodes":["200","404"],"pointer":"/provisioning/api/v1/orders/{uid}/comment","href":"/order/addordercomment","openApiOperationId":"addOrderComment","summary":"Add a note or comment to track order progress and communication"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_377","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_377"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Order not found"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1comment/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/addordercomment"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/{uid}/comment"},{"label":"Mark an order as high priority or requiring special attention","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/addorderflag","routeSlug":"/order/addorderflag","metadata":{"seo":{"title":"Mark an order as high priority or requiring special attention","description":"Sets flagged=true on the order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addOrderFlag","name":"Mark an order as high priority or requiring special attention","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1flag/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mark an order as high priority or requiring special attention","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flagged=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Order UID","required":true}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1flag/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/provisioning/api/v1/orders/{uid}/flag","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/provisioning/api/v1/orders/{uid}/flag","href":"/order/addorderflag","openApiOperationId":"addOrderFlag","summary":"Mark an order as high priority or requiring special attention"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Order not found"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1flag/put/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/addorderflag"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/{uid}/flag"},{"label":"Remove priority flag from an order to normalize processing","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/removeorderflag","routeSlug":"/order/removeorderflag","metadata":{"seo":{"title":"Remove priority flag from an order to normalize processing","description":"Sets flagged=false on the order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeOrderFlag","name":"Remove priority flag from an order to normalize processing","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1flag/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove priority flag from an order to normalize processing","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sets "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"flagged=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Order UID","required":true}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1flag/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/provisioning/api/v1/orders/{uid}/flag","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/provisioning/api/v1/orders/{uid}/flag","href":"/order/removeorderflag","openApiOperationId":"removeOrderFlag","summary":"Remove priority flag from an order to normalize processing"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Order not found"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1flag/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/removeorderflag"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/{uid}/flag"},{"label":"Retrieve audit history for an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/getorderhistory","routeSlug":"/order/getorderhistory","metadata":{"seo":{"title":"Retrieve audit history for an order","description":"Returns the audit trail (changes, status transitions, system messages)for the order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrderHistory","name":"Retrieve audit history for an order","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve audit history for an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the audit trail (changes, status transitions, system messages)"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"for the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"hr","attributes":{},"children":[]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"Order UID","required":true}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/provisioning/api/v1/orders/{uid}/history","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/provisioning/api/v1/orders/{uid}/history","href":"/order/getorderhistory","openApiOperationId":"getOrderHistory","summary":"Retrieve audit history for an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}},"schemaId":"schema_378"},{"code":"404","description":"Order not found"}],"pointer":"/paths/~1provisioning~1api~1v1~1orders~1{uid}~1history/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_378","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_378"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/getorderhistory"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/orders/{uid}/history"},{"label":"List configured order assignees","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/order/listconfigassignees","routeSlug":"/order/listconfigassignees","metadata":{"seo":{"title":"List configured order assignees","description":"Returns the list of configured assignee names from Janine configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listConfigAssignees","name":"List configured order assignees","isWebhook":false,"pointer":"/paths/~1provisioning~1api~1v1~1config~1assignees/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List configured order assignees","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the list of configured assignee names from Janine configuration."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/provisioning/api/v1/config/assignees","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/provisioning/api/v1/config/assignees","href":"/order/listconfigassignees","openApiOperationId":"listConfigAssignees","summary":"List configured order assignees"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}},"schemaId":"schema_243"}],"pointer":"/paths/~1provisioning~1api~1v1~1config~1assignees/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_243","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_243"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/listconfigassignees"}],"panels":[]}]},"httpPath":"/provisioning/api/v1/config/assignees"}],"content":{"contentType":"group","meta":{"name":"Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/provisioning/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Provisioning orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" track the lifecycle of Trustgrid appliances from purchase through deployment. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orders::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/provisioning/api/v1/orders","summary":"Retrieve all hardware provisioning orders and their current status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/listorders","deprecated":false},{"title":"/provisioning/api/v1/orders","summary":"Submit a new hardware provisioning order for appliances or agents","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/createorder","deprecated":false},{"title":"/provisioning/api/v1/orders/creators","summary":"List users who have created orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/listordercreators","deprecated":false},{"title":"/provisioning/api/v1/orders/labels","summary":"List order labels visible to the caller","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/listorderlabels","deprecated":false},{"title":"/provisioning/api/v1/orders/status-counts","summary":"Count orders grouped by status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/getorderstatuscounts","deprecated":false},{"title":"/provisioning/api/v1/orders/webhook","summary":"Create an order from a sales/webhook payload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/createorderwebhook","deprecated":false},{"title":"/provisioning/api/v1/orders/{uid}","summary":"Retrieve detailed information about a specific provisioning order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/getorder","deprecated":false},{"title":"/provisioning/api/v1/orders/{uid}","summary":"Modify the details and requirements of an existing provisioning order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order/updateorder","deprecated":false},{"title":"/provisioning/api/v1/orders/{uid}/attachment","summary":"Attach a file to an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/addorderattachment","deprecated":false},{"title":"/provisioning/api/v1/orders/{uid}/clone","summary":"Clone an existing order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/cloneorder","deprecated":false},{"title":"/provisioning/api/v1/orders/{uid}/comment","summary":"Add a note or comment to track order progress and communication","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/addordercomment","deprecated":false},{"title":"/provisioning/api/v1/orders/{uid}/flag","summary":"Mark an order as high priority or requiring special attention","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order/addorderflag","deprecated":false},{"title":"/provisioning/api/v1/orders/{uid}/flag","summary":"Remove priority flag from an order to normalize processing","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order/removeorderflag","deprecated":false},{"title":"/provisioning/api/v1/orders/{uid}/history","summary":"Retrieve audit history for an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/getorderhistory","deprecated":false},{"title":"/provisioning/api/v1/config/assignees","summary":"List configured order assignees","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/listconfigassignees","deprecated":false}]}]}]}]}},{"type":"group","label":"Permissions","link":"/permissions","routeSlug":"/permissions","items":[{"label":"Retrieve all access control policies and their permission rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/permissions/listpolicies","routeSlug":"/permissions/listpolicies","metadata":{"seo":{"title":"Retrieve all access control policies and their permission rules","description":"Requires permissions::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPolicies","name":"Retrieve all access control policies and their permission rules","isWebhook":false,"pointer":"/paths/~1v2~1policy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all access control policies and their permission rules","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/policy","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/policy","href":"/permissions/listpolicies","openApiOperationId":"listPolicies","summary":"Retrieve all access control policies and their permission rules"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}},"schemaId":"schema_379"}],"pointer":"/paths/~1v2~1policy/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_379","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_379"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/permissions/listpolicies"}],"panels":[]}]},"httpPath":"/v2/policy"},{"label":"Create a new access control policy with specified permissions and conditions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/permissions/paths/~1v2~1policy/post","routeSlug":"/permissions/paths/~1v2~1policy/post","metadata":{"seo":{"title":"Create a new access control policy with specified permissions and conditions","description":"Requires permissions::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new access control policy with specified permissions and conditions","isWebhook":false,"pointer":"/paths/~1v2~1policy/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new access control policy with specified permissions and conditions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a top-level field on the policy object, not nested inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource names use TGRN format, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgrn:tg::nodes:node/{uid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgrn:tg::access-apps:app/{uid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to match all resources of a type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action names must match the exact permission identifier accepted by the API, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:apigw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Policy"}},"schemaId":"components/schemas/Policy","pointer":"/paths/~1v2~1policy/post/requestBody","description":"Policy"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/policy","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Policy"}},"responseCodes":["200","422"],"pointer":"/v2/policy","href":"/permissions/paths/~1v2~1policy/post","summary":"Create a new access control policy with specified permissions and conditions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Policy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Policy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1policy/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/permissions/paths/~1v2~1policy/post"}],"panels":[]}]},"httpPath":"/v2/policy"},{"label":"Remove an access control policy and revoke associated permissions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/permissions/paths/~1v2~1policy~1{name}/delete","routeSlug":"/permissions/paths/~1v2~1policy~1{name}/delete","metadata":{"seo":{"title":"Remove an access control policy and revoke associated permissions","description":"Requires permissions::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove an access control policy and revoke associated permissions","isWebhook":false,"pointer":"/paths/~1v2~1policy~1{name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove an access control policy and revoke associated permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_240","description":"Policy name","required":true}],"pointer":"/paths/~1v2~1policy~1{name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/policy/{name}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/policy/{name}","href":"/permissions/paths/~1v2~1policy~1{name}/delete","summary":"Remove an access control policy and revoke associated permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v2~1policy~1{name}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/permissions/paths/~1v2~1policy~1{name}/delete"}],"panels":[]}]},"httpPath":"/v2/policy/{name}"},{"label":"Retrieve detailed configuration of a specific access control policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/permissions/getpolicy","routeSlug":"/permissions/getpolicy","metadata":{"seo":{"title":"Retrieve detailed configuration of a specific access control policy","description":"Requires permissions::read permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPolicy","name":"Retrieve detailed configuration of a specific access control policy","isWebhook":false,"pointer":"/paths/~1v2~1policy~1{name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed configuration of a specific access control policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_240","description":"Policy name","required":true}],"pointer":"/paths/~1v2~1policy~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/policy/{name}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/policy/{name}","href":"/permissions/getpolicy","openApiOperationId":"getPolicy","summary":"Retrieve detailed configuration of a specific access control policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Policy"}},"schemaId":"components/schemas/Policy"},{"code":"404","description":"Not Found"}],"pointer":"/paths/~1v2~1policy~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Policy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Policy"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/permissions/getpolicy"}],"panels":[]}]},"httpPath":"/v2/policy/{name}"},{"label":"Modify permissions and conditions for an existing access control policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/permissions/paths/~1v2~1policy~1{name}/put","routeSlug":"/permissions/paths/~1v2~1policy~1{name}/put","metadata":{"seo":{"title":"Modify permissions and conditions for an existing access control policy","description":"Requires permissions::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify permissions and conditions for an existing access control policy","isWebhook":false,"pointer":"/paths/~1v2~1policy~1{name}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify permissions and conditions for an existing access control policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a top-level field on the policy object, not nested inside "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"statements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource names use TGRN format, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgrn:tg::nodes:node/{uid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgrn:tg::access-apps:app/{uid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to match all resources of a type."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action names must match the exact permission identifier accepted by the API, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::configure:apigw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_240","description":"Policy name","required":true}],"pointer":"/paths/~1v2~1policy~1{name}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Policy"}},"schemaId":"components/schemas/Policy","pointer":"/paths/~1v2~1policy~1{name}/put/requestBody","description":"Policy"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/policy/{name}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Policy"}},"responseCodes":["200","404","422"],"pointer":"/v2/policy/{name}","href":"/permissions/paths/~1v2~1policy~1{name}/put","summary":"Modify permissions and conditions for an existing access control policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Policy","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Policy"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Not Found"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1policy~1{name}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/permissions/paths/~1v2~1policy~1{name}/put"}],"panels":[]}]},"httpPath":"/v2/policy/{name}"}],"content":{"contentType":"group","meta":{"name":"Permissions"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permissions","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/user-management/policies/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Role-based access control"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" via policies assigning permissions to users and groups. Includes a simulator to evaluate permission decisions. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to configure."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/policy","summary":"Retrieve all access control policies and their permission rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/permissions/listpolicies","deprecated":false},{"title":"/v2/policy","summary":"Create a new access control policy with specified permissions and conditions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/permissions/paths/~1v2~1policy/post","deprecated":false},{"title":"/v2/policy/{name}","summary":"Remove an access control policy and revoke associated permissions","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/permissions/paths/~1v2~1policy~1{name}/delete","deprecated":false},{"title":"/v2/policy/{name}","summary":"Retrieve detailed configuration of a specific access control policy","prefix":{"name":"get","color":"get"},"badges":[],"link":"/permissions/getpolicy","deprecated":false},{"title":"/v2/policy/{name}","summary":"Modify permissions and conditions for an existing access control policy","prefix":{"name":"put","color":"put"},"badges":[],"link":"/permissions/paths/~1v2~1policy~1{name}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"ServiceUser","link":"/serviceuser","routeSlug":"/serviceuser","items":[{"label":"Retrieve configuration details for a specific service account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/serviceuser/getserviceuser","routeSlug":"/serviceuser/getserviceuser","metadata":{"seo":{"title":"Retrieve configuration details for a specific service account","description":"Retrieve configuration details for a specific service account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getServiceUser","name":"Retrieve configuration details for a specific service account","isWebhook":false,"pointer":"/paths/~1v2~1service-user~1{name}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve configuration details for a specific service account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_240","description":"The name of the service user","required":true}],"pointer":"/paths/~1v2~1service-user~1{name}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/service-user/{name}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/service-user/{name}","href":"/serviceuser/getserviceuser","openApiOperationId":"getServiceUser","summary":"Retrieve configuration details for a specific service account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A service user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUser"}},"schemaId":"components/schemas/ServiceUser"},{"code":"404","description":"Service user not found"}],"pointer":"/paths/~1v2~1service-user~1{name}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/ServiceUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUser"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/serviceuser/getserviceuser"}],"panels":[]}]},"httpPath":"/v2/service-user/{name}"},{"label":"Generate new API credentials (client ID and secret) for a service account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/serviceuser/paths/~1v2~1service-user~1{name}~1token/post","routeSlug":"/serviceuser/paths/~1v2~1service-user~1{name}~1token/post","metadata":{"seo":{"title":"Generate new API credentials (client ID and secret) for a service account","description":"Generate new API credentials (client ID and secret) for a service account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Generate new API credentials (client ID and secret) for a service account","isWebhook":false,"pointer":"/paths/~1v2~1service-user~1{name}~1token/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate new API credentials (client ID and secret) for a service account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"name","in":"path","schemaId":"schema_240","description":"The name of the service user","required":true}],"pointer":"/paths/~1v2~1service-user~1{name}~1token/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/service-user/{name}/token","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"name","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/service-user/{name}/token","href":"/serviceuser/paths/~1v2~1service-user~1{name}~1token/post","summary":"Generate new API credentials (client ID and secret) for a service account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"API credentials","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}},"schemaId":"schema_380"},{"code":"404","description":"Service user not found"}],"pointer":"/paths/~1v2~1service-user~1{name}~1token/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_380","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_380"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/serviceuser/paths/~1v2~1service-user~1{name}~1token/post"}],"panels":[]}]},"httpPath":"/v2/service-user/{name}/token"},{"label":"Retrieve all API-only service accounts configured for the organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/serviceuser/listserviceusers","routeSlug":"/serviceuser/listserviceusers","metadata":{"seo":{"title":"Retrieve all API-only service accounts configured for the organization","description":"Retrieve all API-only service accounts configured for the organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listServiceUsers","name":"Retrieve all API-only service accounts configured for the organization","isWebhook":false,"pointer":"/paths/~1v2~1service-user/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all API-only service accounts configured for the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/service-user","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/service-user","href":"/serviceuser/listserviceusers","openApiOperationId":"listServiceUsers","summary":"Retrieve all API-only service accounts configured for the organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of service users","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}},"schemaId":"schema_381"}],"pointer":"/paths/~1v2~1service-user/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_381","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_381"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/serviceuser/listserviceusers"}],"panels":[]}]},"httpPath":"/v2/service-user"},{"label":"Create a new API-only service account with specified permissions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/serviceuser/paths/~1v2~1service-user/post","routeSlug":"/serviceuser/paths/~1v2~1service-user/post","metadata":{"seo":{"title":"Create a new API-only service account with specified permissions","description":"Create a new API-only service account with specified permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new API-only service account with specified permissions","isWebhook":false,"pointer":"/paths/~1v2~1service-user/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new API-only service account with specified permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_382"}},"schemaId":"schema_382","pointer":"/paths/~1v2~1service-user/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/service-user","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_382"}},"responseCodes":["201","400"],"pointer":"/v2/service-user","href":"/serviceuser/paths/~1v2~1service-user/post","summary":"Create a new API-only service account with specified permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_382","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_382"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Service user created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUser"}},"schemaId":"components/schemas/ServiceUser"},{"code":"400","description":"Invalid input"}],"pointer":"/paths/~1v2~1service-user/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/ServiceUser","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ServiceUser"}}},{"code":"400"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/serviceuser/paths/~1v2~1service-user/post"}],"panels":[]}]},"httpPath":"/v2/service-user"}],"content":{"contentType":"group","meta":{"name":"ServiceUser"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"ServiceUser","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Machine accounts for API-only access, used for automation and integrations. Each service user can have API tokens generated without portal access. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/service-user/{name}","summary":"Retrieve configuration details for a specific service account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/serviceuser/getserviceuser","deprecated":false},{"title":"/v2/service-user/{name}/token","summary":"Generate new API credentials (client ID and secret) for a service account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/serviceuser/paths/~1v2~1service-user~1{name}~1token/post","deprecated":false},{"title":"/v2/service-user","summary":"Retrieve all API-only service accounts configured for the organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/serviceuser/listserviceusers","deprecated":false},{"title":"/v2/service-user","summary":"Create a new API-only service account with specified permissions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/serviceuser/paths/~1v2~1service-user/post","deprecated":false}]}]}]}]}},{"type":"group","label":"SplunkExporter","link":"/splunkexporter","routeSlug":"/splunkexporter","items":[{"label":"Retrieve Splunk-specific configuration for a telemetry data exporter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/splunkexporter/getsplunkobservabilityexporter","routeSlug":"/splunkexporter/getsplunkobservabilityexporter","metadata":{"seo":{"title":"Retrieve Splunk-specific configuration for a telemetry data exporter","description":"Requires observability::read permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSplunkObservabilityExporter","name":"Retrieve Splunk-specific configuration for a telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve Splunk-specific configuration for a telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/observability-exporter/splunk/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2/observability-exporter/splunk/{id}","href":"/splunkexporter/getsplunkobservabilityexporter","openApiOperationId":"getSplunkObservabilityExporter","summary":"Retrieve Splunk-specific configuration for a telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"An observability exporter","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}},"schemaId":"components/schemas/SplunkExporter"},{"code":"404","description":"Observability exporter not found"}],"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/SplunkExporter","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/splunkexporter/getsplunkobservabilityexporter"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/splunk/{id}"},{"label":"Modify Splunk-specific settings for a telemetry data exporter","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/splunkexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put","routeSlug":"/splunkexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put","metadata":{"seo":{"title":"Modify Splunk-specific settings for a telemetry data exporter","description":"Requires observability::modify permission and Organization observability feature needs to be enabled."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Modify Splunk-specific settings for a telemetry data exporter","isWebhook":false,"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify Splunk-specific settings for a telemetry data exporter","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission and Organization "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature needs to be enabled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_240","description":"The id of the observability exporter","required":true}],"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}},"schemaId":"components/schemas/SplunkExporter","pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/put/requestBody","description":"Splunk Exporter"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2/observability-exporter/splunk/{id}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}},"responseCodes":["200","404","422"],"pointer":"/v2/observability-exporter/splunk/{id}","href":"/splunkexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put","summary":"Modify Splunk-specific settings for a telemetry data exporter"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/SplunkExporter","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/SplunkExporter"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"404","description":"Observability exporter not found"},{"code":"422","description":"Validation failed","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1v2~1observability-exporter~1splunk~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"404"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/splunkexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put"}],"panels":[]}]},"httpPath":"/v2/observability-exporter/splunk/{id}"}],"content":{"contentType":"group","meta":{"name":"SplunkExporter"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"SplunkExporter","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Splunk-specific observability exporter configuration for forwarding Trustgrid telemetry to a Splunk HEC endpoint. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to configure. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"observability"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature flag."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/observability-exporter/splunk/{id}","summary":"Retrieve Splunk-specific configuration for a telemetry data exporter","prefix":{"name":"get","color":"get"},"badges":[],"link":"/splunkexporter/getsplunkobservabilityexporter","deprecated":false},{"title":"/v2/observability-exporter/splunk/{id}","summary":"Modify Splunk-specific settings for a telemetry data exporter","prefix":{"name":"put","color":"put"},"badges":[],"link":"/splunkexporter/paths/~1v2~1observability-exporter~1splunk~1{id}/put","deprecated":false}]}]}]}]}},{"type":"group","label":"Tag","link":"/tag","routeSlug":"/tag","items":[{"label":"Retrieve all available metadata tags used for node and cluster organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tag/listtags","routeSlug":"/tag/listtags","metadata":{"seo":{"title":"Retrieve all available metadata tags used for node and cluster organization","description":"Retrieve all available metadata tags used for node and cluster organization"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listTags","name":"Retrieve all available metadata tags used for node and cluster organization","isWebhook":false,"pointer":"/paths/~1tags/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all available metadata tags used for node and cluster organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/tags","href":"/tag/listtags","openApiOperationId":"listTags","summary":"Retrieve all available metadata tags used for node and cluster organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_383"}},"schemaId":"schema_383"}],"pointer":"/paths/~1tags/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_383","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_383"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag/listtags"}],"panels":[]}]},"httpPath":"/tags"},{"label":"Retrieve details and usage information for a specific tag","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/tag/gettag","routeSlug":"/tag/gettag","metadata":{"seo":{"title":"Retrieve details and usage information for a specific tag","description":"Retrieve details and usage information for a specific tag"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getTag","name":"Retrieve details and usage information for a specific tag","isWebhook":false,"pointer":"/paths/~1tags~1{tagName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve details and usage information for a specific tag","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"tagName","in":"path","schemaId":"schema_240","description":"Tag name","required":true}],"pointer":"/paths/~1tags~1{tagName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/tags/{tagName}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"tagName","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/tags/{tagName}","href":"/tag/gettag","openApiOperationId":"getTag","summary":"Retrieve details and usage information for a specific tag"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}},"schemaId":"components/schemas/Tag"},{"code":"404","description":"Tag not found"}],"pointer":"/paths/~1tags~1{tagName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Tag","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Tag"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag/gettag"}],"panels":[]}]},"httpPath":"/tags/{tagName}"}],"content":{"contentType":"group","meta":{"name":"Tag"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/nodes/shared/tags/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are key-value metadata attached to nodes and clusters for grouping, permissions scoping, and dashboard filtering. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to view, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to modify."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/tags","summary":"Retrieve all available metadata tags used for node and cluster organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag/listtags","deprecated":false},{"title":"/tags/{tagName}","summary":"Retrieve details and usage information for a specific tag","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag/gettag","deprecated":false}]}]}]}]}},{"type":"group","label":"User","link":"/user","routeSlug":"/user","items":[{"label":"Retrieve all user groups and their access permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/listgroups","routeSlug":"/user/listgroups","metadata":{"seo":{"title":"Retrieve all user groups and their access permissions","description":"Requires groups::read permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroups","name":"Retrieve all user groups and their access permissions","isWebhook":false,"pointer":"/paths/~1group/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all user groups and their access permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group","href":"/user/listgroups","openApiOperationId":"listGroups","summary":"Retrieve all user groups and their access permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of groups","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}},"schemaId":"schema_363"}],"pointer":"/paths/~1group/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_363","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_363"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/listgroups"}],"panels":[]}]},"httpPath":"/group"},{"label":"Create a new user group with specified access permissions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1group/post","routeSlug":"/user/paths/~1group/post","metadata":{"seo":{"title":"Create a new user group with specified access permissions","description":"Requires groups::modify permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Create a new user group with specified access permissions","isWebhook":false,"pointer":"/paths/~1group/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a new user group with specified access permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Group"}},"schemaId":"components/schemas/Group","pointer":"/paths/~1group/post/requestBody","description":"The group object to be created"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/group","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Group"}},"responseCodes":["200"],"pointer":"/group","href":"/user/paths/~1group/post","summary":"Create a new user group with specified access permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/Group","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Group"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Group successfully created"}],"pointer":"/paths/~1group/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1group/post"}],"panels":[]}]},"httpPath":"/group"},{"label":"Remove a user from a group and revoke associated permissions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1group~1{groupid}~1members~1{email}/delete","routeSlug":"/user/paths/~1group~1{groupid}~1members~1{email}/delete","metadata":{"seo":{"title":"Remove a user from a group and revoke associated permissions","description":"Requires groups::modify permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a user from a group and revoke associated permissions","isWebhook":false,"pointer":"/paths/~1group~1{groupId}~1members~1{email}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a user from a group and revoke associated permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"groupId","in":"path","schemaId":"schema_240","description":"ID of the group to remove a member from","required":true},{"name":"email","in":"path","schemaId":"schema_240","description":"Email of the member to be removed","required":true}],"pointer":"/paths/~1group~1{groupId}~1members~1{email}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/group/{groupId}/members/{email}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"groupId","in":"path","required":true,"schemaId":"schema_240"},{"name":"email","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group/{groupId}/members/{email}","href":"/user/paths/~1group~1{groupid}~1members~1{email}/delete","summary":"Remove a user from a group and revoke associated permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Member successfully removed from the group"}],"pointer":"/paths/~1group~1{groupId}~1members~1{email}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1group~1{groupid}~1members~1{email}/delete"}],"panels":[]}]},"httpPath":"/group/{groupId}/members/{email}"},{"label":"Permanently delete a group and remove all member associations","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1group~1{uid}/delete","routeSlug":"/user/paths/~1group~1{uid}/delete","metadata":{"seo":{"title":"Permanently delete a group and remove all member associations","description":"Requires groups::modify permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Permanently delete a group and remove all member associations","isWebhook":false,"pointer":"/paths/~1group~1{uid}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permanently delete a group and remove all member associations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"ID of the group to delete","required":true}],"pointer":"/paths/~1group~1{uid}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/group/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group/{uid}","href":"/user/paths/~1group~1{uid}/delete","summary":"Permanently delete a group and remove all member associations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Group successfully deleted"}],"pointer":"/paths/~1group~1{uid}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1group~1{uid}/delete"}],"panels":[]}]},"httpPath":"/group/{uid}"},{"label":"Retrieve detailed information about a specific group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/getgroup","routeSlug":"/user/getgroup","metadata":{"seo":{"title":"Retrieve detailed information about a specific group","description":"Requires groups::read permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGroup","name":"Retrieve detailed information about a specific group","isWebhook":false,"pointer":"/paths/~1group~1{uid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve detailed information about a specific group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"UID of the group to retrieve","required":true}],"pointer":"/paths/~1group~1{uid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/group/{uid}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/group/{uid}","href":"/user/getgroup","openApiOperationId":"getGroup","summary":"Retrieve detailed information about a specific group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The group object","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Group"}},"schemaId":"components/schemas/Group"},{"code":"404","description":"Group does not exist"}],"pointer":"/paths/~1group~1{uid}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Group","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Group"}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/getgroup"}],"panels":[]}]},"httpPath":"/group/{uid}"},{"label":"List all identity providers associated with a group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/listgroupidps","routeSlug":"/user/listgroupidps","metadata":{"seo":{"title":"List all identity providers associated with a group","description":"Requires groups::read permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroupIdps","name":"List all identity providers associated with a group","isWebhook":false,"pointer":"/paths/~1group~1{uid}~1idps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all identity providers associated with a group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"UID of the group","required":true}],"pointer":"/paths/~1group~1{uid}~1idps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/group/{uid}/idps","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group/{uid}/idps","href":"/user/listgroupidps","openApiOperationId":"listGroupIdps","summary":"List all identity providers associated with a group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of Identity Providers","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}},"schemaId":"schema_364"}],"pointer":"/paths/~1group~1{uid}~1idps/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_364","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_364"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/listgroupidps"}],"panels":[]}]},"httpPath":"/group/{uid}/idps"},{"label":"Retrieve all users that belong to a specific group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/listgroupmembers","routeSlug":"/user/listgroupmembers","metadata":{"seo":{"title":"Retrieve all users that belong to a specific group","description":"Requires groups::read permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGroupMembers","name":"Retrieve all users that belong to a specific group","isWebhook":false,"pointer":"/paths/~1group~1{uid}~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all users that belong to a specific group","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"UID of the group","required":true}],"pointer":"/paths/~1group~1{uid}~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/group/{uid}/members","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/group/{uid}/members","href":"/user/listgroupmembers","openApiOperationId":"listGroupMembers","summary":"Retrieve all users that belong to a specific group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"List of group members","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}},"schemaId":"schema_365"}],"pointer":"/paths/~1group~1{uid}~1members/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_365","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_365"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/listgroupmembers"}],"panels":[]}]},"httpPath":"/group/{uid}/members"},{"label":"Add a new user to a group and grant associated permissions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1group~1{uid}~1members/post","routeSlug":"/user/paths/~1group~1{uid}~1members/post","metadata":{"seo":{"title":"Add a new user to a group and grant associated permissions","description":"Requires groups::modify permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a new user to a group and grant associated permissions","isWebhook":false,"pointer":"/paths/~1group~1{uid}~1members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a new user to a group and grant associated permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions"},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"uid","in":"path","schemaId":"schema_240","description":"ID of the group to add a member to","required":true}],"pointer":"/paths/~1group~1{uid}~1members/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupMember"}},"schemaId":"components/schemas/GroupMember","pointer":"/paths/~1group~1{uid}~1members/post/requestBody","description":"The group member object to be added"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/group/{uid}/members","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"uid","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/GroupMember"}},"responseCodes":["200"],"pointer":"/group/{uid}/members","href":"/user/paths/~1group~1{uid}~1members/post","summary":"Add a new user to a group and grant associated permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"components/schemas/GroupMember","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/GroupMember"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Member successfully added to the group"}],"pointer":"/paths/~1group~1{uid}~1members/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1group~1{uid}~1members/post"}],"panels":[]}]},"httpPath":"/group/{uid}/members"},{"label":"Retrieve all users in the organization with their roles and permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/listusers","routeSlug":"/user/listusers","metadata":{"seo":{"title":"Retrieve all users in the organization with their roles and permissions","description":"Changes to users sometimes take a few minutes to appear while being indexed"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUsers","name":"Retrieve all users in the organization with their roles and permissions","isWebhook":false,"pointer":"/paths/~1user/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all users in the organization with their roles and permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Changes to users sometimes take a few minutes to appear while being indexed\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/user","href":"/user/listusers","openApiOperationId":"listUsers","summary":"Retrieve all users in the organization with their roles and permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}},"schemaId":"schema_384"}],"pointer":"/paths/~1user/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_384","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_384"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/listusers"}],"panels":[]}]},"httpPath":"/user"},{"label":"Send an invitation email to a new user to join the organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1user/post","routeSlug":"/user/paths/~1user/post","metadata":{"seo":{"title":"Send an invitation email to a new user to join the organization","description":"For organizations using the default Trustgrid authentication provider, users must be invited and then they should sign up with the invited email address.For custom IDP integrations, users should be added instead."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Send an invitation email to a new user to join the organization","isWebhook":false,"pointer":"/paths/~1user/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Send an invitation email to a new user to join the organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For organizations using the default Trustgrid authentication provider, users must be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"invited"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and then they should sign up with the invited email address."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For custom IDP integrations, users should be "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"added"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_385"}},"schemaId":"schema_385","pointer":"/paths/~1user/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_385"}},"responseCodes":["200"],"pointer":"/user","href":"/user/paths/~1user/post","summary":"Send an invitation email to a new user to join the organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_385","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_385"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1user/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1user/post"}],"panels":[]}]},"httpPath":"/user"},{"label":"Directly add a user account for organizations with custom identity providers","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1user~1add/post","routeSlug":"/user/paths/~1user~1add/post","metadata":{"seo":{"title":"Directly add a user account for organizations with custom identity providers","description":"Add a user. This is only available to organizations with custom IDP integrations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Directly add a user account for organizations with custom identity providers","isWebhook":false,"pointer":"/paths/~1user~1add/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Directly add a user account for organizations with custom identity providers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add a user. This is only available to organizations with custom IDP integrations.\n"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"schemaId":"schema_386","pointer":"/paths/~1user~1add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user/add","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_386"}},"responseCodes":["200"],"pointer":"/user/add","href":"/user/paths/~1user~1add/post","summary":"Directly add a user account for organizations with custom identity providers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_386","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_386"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1user~1add/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1user~1add/post"}],"panels":[]}]},"httpPath":"/user/add"},{"label":"Permanently remove a user from the organization and revoke all access","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1user~1{email}/delete","routeSlug":"/user/paths/~1user~1{email}/delete","metadata":{"seo":{"title":"Permanently remove a user from the organization and revoke all access","description":"Permanently remove a user from the organization and revoke all access"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Permanently remove a user from the organization and revoke all access","isWebhook":false,"pointer":"/paths/~1user~1{email}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Permanently remove a user from the organization and revoke all access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"schema_240","description":"User email","required":true}],"pointer":"/paths/~1user~1{email}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/user/{email}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200","422"],"pointer":"/user/{email}","href":"/user/paths/~1user~1{email}/delete","summary":"Permanently remove a user from the organization and revoke all access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"},{"code":"422","description":"Cannot delete root user","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}},"schemaId":"components/schemas/ValidationFailed"}],"pointer":"/paths/~1user~1{email}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200"},{"code":"422","schemaId":"components/schemas/ValidationFailed","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ValidationFailed"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1user~1{email}/delete"}],"panels":[]}]},"httpPath":"/user/{email}"},{"label":"Retrieve the effective merged policy for a user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1user~1{email}~1policy/get","routeSlug":"/user/paths/~1user~1{email}~1policy/get","metadata":{"seo":{"title":"Retrieve the effective merged policy for a user","description":"Returns the combined policy derived from all policies directly attached to the user plus those inherited via group membership."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Retrieve the effective merged policy for a user","isWebhook":false,"pointer":"/paths/~1user~1{email}~1policy/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the effective merged policy for a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the combined policy derived from all policies directly attached to the user plus those inherited via group membership."},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"schema_240","description":"User email","required":true}],"pointer":"/paths/~1user~1{email}~1policy/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user/{email}/policy","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/user/{email}/policy","href":"/user/paths/~1user~1{email}~1policy/get","summary":"Retrieve the effective merged policy for a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Policy"}},"schemaId":"components/schemas/Policy"}],"pointer":"/paths/~1user~1{email}~1policy/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/Policy","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Policy"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1user~1{email}~1policy/get"}],"panels":[]}]},"httpPath":"/user/{email}/policy"},{"label":"Attach a named policy to a user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1user~1{email}~1policy~1{name}/post","routeSlug":"/user/paths/~1user~1{email}~1policy~1{name}/post","metadata":{"seo":{"title":"Attach a named policy to a user","description":"Adds name to the user's set of directly attached policies."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Attach a named policy to a user","isWebhook":false,"pointer":"/paths/~1user~1{email}~1policy~1{name}/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Attach a named policy to a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the user's set of directly attached policies."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Policies whose names start with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"restricted-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be attached via this endpoint."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"schema_240","description":"User email","required":true},{"name":"name","in":"path","schemaId":"schema_240","description":"Policy name","required":true}],"pointer":"/paths/~1user~1{email}~1policy~1{name}/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/user/{email}/policy/{name}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"schema_240"},{"name":"name","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/user/{email}/policy/{name}","href":"/user/paths/~1user~1{email}~1policy~1{name}/post","summary":"Attach a named policy to a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1user~1{email}~1policy~1{name}/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1user~1{email}~1policy~1{name}/post"}],"panels":[]}]},"httpPath":"/user/{email}/policy/{name}"},{"label":"Detach a named policy from a user","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1user~1{email}~1policy~1{name}/delete","routeSlug":"/user/paths/~1user~1{email}~1policy~1{name}/delete","metadata":{"seo":{"title":"Detach a named policy from a user","description":"Requires permissions::modify permission."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Detach a named policy from a user","isWebhook":false,"pointer":"/paths/~1user~1{email}~1policy~1{name}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Detach a named policy from a user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions::modify"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"schema_240","description":"User email","required":true},{"name":"name","in":"path","schemaId":"schema_240","description":"Policy name","required":true}],"pointer":"/paths/~1user~1{email}~1policy~1{name}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/user/{email}/policy/{name}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"schema_240"},{"name":"name","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/user/{email}/policy/{name}","href":"/user/paths/~1user~1{email}~1policy~1{name}/delete","summary":"Detach a named policy from a user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1user~1{email}~1policy~1{name}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1user~1{email}~1policy~1{name}/delete"}],"panels":[]}]},"httpPath":"/user/{email}/policy/{name}"},{"label":"Retrieve all groups that a specific user belongs to","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/listusergroups","routeSlug":"/user/listusergroups","metadata":{"seo":{"title":"Retrieve all groups that a specific user belongs to","description":"Retrieve all groups that a specific user belongs to"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listUserGroups","name":"Retrieve all groups that a specific user belongs to","isWebhook":false,"pointer":"/paths/~1user~1{email}~1groups/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve all groups that a specific user belongs to","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"schema_240","description":"User email","required":true}],"pointer":"/paths/~1user~1{email}~1groups/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/user/{email}/groups","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/user/{email}/groups","href":"/user/listusergroups","openApiOperationId":"listUserGroups","summary":"Retrieve all groups that a specific user belongs to"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}},"schemaId":"schema_387"}],"pointer":"/paths/~1user~1{email}~1groups/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_387","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_387"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/listusergroups"}],"panels":[]}]},"httpPath":"/user/{email}/groups"},{"label":"Add a user to a group and grant associated permissions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1v2~1user~1{email}~1groups/post","routeSlug":"/user/paths/~1v2~1user~1{email}~1groups/post","metadata":{"seo":{"title":"Add a user to a group and grant associated permissions","description":"Add a user to a group and grant associated permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Add a user to a group and grant associated permissions","isWebhook":false,"pointer":"/paths/~1v2~1user~1{email}~1groups/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a user to a group and grant associated permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"schema_240","description":"User email","required":true}],"pointer":"/paths/~1v2~1user~1{email}~1groups/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_388"}},"schemaId":"schema_388","pointer":"/paths/~1v2~1user~1{email}~1groups/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2/user/{email}/groups","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_388"}},"responseCodes":["200"],"pointer":"/v2/user/{email}/groups","href":"/user/paths/~1v2~1user~1{email}~1groups/post","summary":"Add a user to a group and grant associated permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"schemaId":"schema_388","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_388"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1user~1{email}~1groups/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1v2~1user~1{email}~1groups/post"}],"panels":[]}]},"httpPath":"/v2/user/{email}/groups"},{"label":"Remove a user from a group and revoke associated permissions","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/user/paths/~1v2~1user~1{email}~1groups~1{group}/delete","routeSlug":"/user/paths/~1v2~1user~1{email}~1groups~1{group}/delete","metadata":{"seo":{"title":"Remove a user from a group and revoke associated permissions","description":"Remove a user from a group and revoke associated permissions"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"name":"Remove a user from a group and revoke associated permissions","isWebhook":false,"pointer":"/paths/~1v2~1user~1{email}~1groups~1{group}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a user from a group and revoke associated permissions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"JWTAuthorizer","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"email","in":"path","schemaId":"schema_240","description":"User email","required":true},{"name":"group","in":"path","schemaId":"schema_240","description":"Group ID","required":true}],"pointer":"/paths/~1v2~1user~1{email}~1groups~1{group}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2/user/{email}/groups/{group}","servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"parameters":{"path":[{"name":"email","in":"path","required":true,"schemaId":"schema_240"},{"name":"group","in":"path","required":true,"schemaId":"schema_240"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2/user/{email}/groups/{group}","href":"/user/paths/~1v2~1user~1{email}~1groups~1{group}/delete","summary":"Remove a user from a group and revoke associated permissions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/","description":"Mock server","isMockServer":true},{"url":"https://api.trustgrid.io"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK"}],"pointer":"/paths/~1v2~1user~1{email}~1groups~1{group}/delete/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/user/paths/~1v2~1user~1{email}~1groups~1{group}/delete"}],"panels":[]}]},"httpPath":"/v2/user/{email}/groups/{group}"}],"content":{"contentType":"group","meta":{"name":"User"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"User","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.trustgrid.io/docs/user-management/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"User"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" accounts for portal and API access. Authenticated via SSO (IDP) or local credentials and assigned permissions via policies. Requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users::read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/group","summary":"Retrieve all user groups and their access permissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/listgroups","deprecated":false},{"title":"/group","summary":"Create a new user group with specified access permissions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/paths/~1group/post","deprecated":false},{"title":"/group/{groupId}/members/{email}","summary":"Remove a user from a group and revoke associated permissions","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user/paths/~1group~1{groupid}~1members~1{email}/delete","deprecated":false},{"title":"/group/{uid}","summary":"Permanently delete a group and remove all member associations","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user/paths/~1group~1{uid}/delete","deprecated":false},{"title":"/group/{uid}","summary":"Retrieve detailed information about a specific group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/getgroup","deprecated":false},{"title":"/group/{uid}/idps","summary":"List all identity providers associated with a group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/listgroupidps","deprecated":false},{"title":"/group/{uid}/members","summary":"Retrieve all users that belong to a specific group","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/listgroupmembers","deprecated":false},{"title":"/group/{uid}/members","summary":"Add a new user to a group and grant associated permissions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/paths/~1group~1{uid}~1members/post","deprecated":false},{"title":"/user","summary":"Retrieve all users in the organization with their roles and permissions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/listusers","deprecated":false},{"title":"/user","summary":"Send an invitation email to a new user to join the organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/paths/~1user/post","deprecated":false},{"title":"/user/add","summary":"Directly add a user account for organizations with custom identity providers","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/paths/~1user~1add/post","deprecated":false},{"title":"/user/{email}","summary":"Permanently remove a user from the organization and revoke all access","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user/paths/~1user~1{email}/delete","deprecated":false},{"title":"/user/{email}/policy","summary":"Retrieve the effective merged policy for a user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/paths/~1user~1{email}~1policy/get","deprecated":false},{"title":"/user/{email}/policy/{name}","summary":"Attach a named policy to a user","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/paths/~1user~1{email}~1policy~1{name}/post","deprecated":false},{"title":"/user/{email}/policy/{name}","summary":"Detach a named policy from a user","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user/paths/~1user~1{email}~1policy~1{name}/delete","deprecated":false},{"title":"/user/{email}/groups","summary":"Retrieve all groups that a specific user belongs to","prefix":{"name":"get","color":"get"},"badges":[],"link":"/user/listusergroups","deprecated":false},{"title":"/v2/user/{email}/groups","summary":"Add a user to a group and grant associated permissions","prefix":{"name":"post","color":"post"},"badges":[],"link":"/user/paths/~1v2~1user~1{email}~1groups/post","deprecated":false},{"title":"/v2/user/{email}/groups/{group}","summary":"Remove a user from a group and revoke associated permissions","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/user/paths/~1v2~1user~1{email}~1groups~1{group}/delete","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AlarmChannelModel":{"id":"components/schemas/AlarmChannelModel","kind":"json-schema","title":"AlarmChannel","data":{"description":"A notification channel used to deliver alarm alerts. Exactly one of the channel-type fields should be populated to indicate the delivery method.","properties":{"name":{"description":"Human-readable name for the channel","type":"string"},"uid":{"description":"Unique identifier for this channel","type":"string"},"orgId":{"description":"Organization ID that owns this channel","type":"string"},"internal":{"description":"Whether this channel is managed by Trustgrid (read-only)","type":"boolean"},"emails":{"description":"Comma-separated email addresses for email delivery","type":"string"},"slackWebhook":{"description":"Slack incoming webhook URL","type":"string"},"slackChannel":{"description":"Slack channel name (requires Slack integration)","type":"string"},"pagerduty":{"description":"PagerDuty integration key","type":"string"},"opsGenie":{"description":"OpsGenie API key","type":"string"},"msTeams":{"description":"Microsoft Teams webhook URL","type":"string"},"genericWebhook":{"description":"Generic HTTPS webhook URL for custom integrations","type":"string"}},"required":["name"],"title":"AlarmChannel","type":"object"}},"components/schemas/AlarmModel":{"id":"components/schemas/AlarmModel","kind":"json-schema","title":"Alarm","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An alarm filter that watches for matching events and delivers alerts to configured channels. Criteria fields are combined using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"uid":{"description":"Unique identifier for this alarm filter","type":"string"},"name":{"description":"Human-readable name for the alarm filter","type":"string"},"description":{"description":"Optional description of the alarm's purpose","type":"string"},"enabled":{"description":"Whether this alarm filter is active","type":"boolean"},"internal":{"description":"Whether this alarm is managed by Trustgrid (read-only)","type":"boolean"},"orgId":{"description":"Organization ID that owns this alarm","type":"string"},"channels":{"description":"UIDs of AlarmChannels to notify when this alarm triggers","items":{"type":"string"},"type":"array"},"types":{"description":"Event types to match (e.g., \"Node Connect\", \"Node Disconnect\", \"Network Error\"). An empty list matches all types.","items":{"type":"string"},"type":"array"},"nodes":{"description":"Node names to scope this alarm to. Empty matches all nodes.","items":{"type":"string"},"type":"array"},"tags":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tag filters expressed as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"key=value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" strings. Nodes must match these tags (combined per "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"operator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to trigger this alarm."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"operator":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How multiple criteria (nodes, tags, types) are combined. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = all criteria must match; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = at least one must match; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = no criteria should match."},"children":[]}]}]}],"enum":["any","all","none"],"type":"string"},"tagsOperator":{"description":"How multiple tag criteria are combined","enum":["any","all"],"type":"string"},"threshold":{"description":"Minimum event severity level to trigger this alarm","enum":["INFO","WARNING","ERROR","CRITICAL"],"type":"string"},"freetext":{"description":"Free-text string that must appear in the event message","type":"string"},"expr":{"description":"CEL (Common Expression Language) expression for advanced matching","type":"string"}},"required":["name"],"title":"Alarm","type":"object"}},"components/schemas/Alert":{"id":"components/schemas/Alert","kind":"json-schema","title":"Alert","data":{"description":"Alert","properties":{"alert_message":{"description":"More information about the alert","example":"Node mynode abnormally disconnected","type":"string"},"node":{"description":"Node name that generated the alert","example":"mynode","type":"string"},"node_id":{"description":"Node ID that generated the alert","example":"19084f81-5668-41ee-adbe-295e4c65531a","type":"string"},"timestamp":{"description":"Unix timestamp of alert","example":1661440360,"type":"number"},"type":{"description":"Type of alert","example":"Data Plane Disruption","type":"string"},"uid":{"description":"Unique ID of alert","example":"2DqxLdknjWxEkGt474d2Cstsa1O","type":"string"}},"title":"Alert","type":"object"}},"components/schemas/AlertSuppressionModel":{"id":"components/schemas/AlertSuppressionModel","kind":"json-schema","title":"AlertSuppression","data":{"properties":{"description":{"type":"string"},"end":{"format":"date-time","type":"string"},"start":{"format":"date-time","type":"string"}},"required":["start","end"],"title":"AlertSuppression","type":"object"}},"components/schemas/AlertV2":{"id":"components/schemas/AlertV2","kind":"json-schema","title":"Alert V2","data":{"description":"Alert V2","properties":{"eventType":{"description":"Type of alert","example":"Data Plane Disruption","type":"string"},"message":{"description":"More information about the alert","example":"Node mynode abnormally disconnected","type":"string"},"nodeId":{"description":"Node ID that generated the alert","example":"19084f81-5668-41ee-adbe-295e4c65531a","type":"string"},"nodeName":{"description":"Node name that generated the alert","example":"mynode","type":"string"},"timestamp":{"description":"Unix timestamp of alert","example":1661440360,"type":"number"},"uid":{"description":"Unique ID of alert","example":"2DqxLdknjWxEkGt474d2Cstsa1O","type":"string"}},"title":"Alert V2","type":"object"}},"components/schemas/AuthAuditRecord":{"id":"components/schemas/AuthAuditRecord","kind":"json-schema","title":"AuthAuditRecord","data":{"description":"An authentication audit event","properties":{"uid":{"description":"Unique identifier","type":"string"},"org":{"description":"Organization ID","type":"string"},"timestamp":{"description":"Timestamp of the event (ISO 8601)","example":"2024-10-21T17:35:26Z","type":"string"},"ip":{"description":"IP address of the client","example":"44.44.44.43","type":"string"},"message":{"description":"Human-readable description of the authentication event","example":"Portal login (Local Authentication)","type":"string"},"userId":{"description":"User who performed the authentication","example":"admin@example.com","type":"string"}},"type":"object"}},"components/schemas/ChangeAuditConfig":{"id":"components/schemas/ChangeAuditConfig","kind":"json-schema","title":"ChangeAuditConfig","data":{"description":"Metadata for filtering configuration change audits","properties":{"auditTypes":{"description":"Available audit event types","type":"array","items":{"type":"string"},"example":["change","create","delete","action"]},"itemTypes":{"description":"Available item types with display metadata","type":"object","additionalProperties":{"type":"object","properties":{"link":{"description":"URL path for the item type in the portal","type":"string"},"displayName":{"description":"Human-readable display name","type":"string"}}}}},"type":"object"}},"components/schemas/ChangeAuditRecord":{"id":"components/schemas/ChangeAuditRecord","kind":"json-schema","title":"ChangeAuditRecord","data":{"description":"A configuration change audit event","properties":{"uid":{"description":"Unique identifier","type":"string"},"org":{"description":"Organization ID","type":"string"},"timestamp":{"description":"Timestamp of the change (ISO 8601)","example":"2024-10-21T17:35:26Z","type":"string"},"ip":{"description":"IP address of the client that initiated the change","example":"44.44.44.43","type":"string"},"userName":{"description":"User who initiated the change","example":"admin@trustgrid.io","type":"string"},"itemType":{"description":"Type of the item that was changed","example":"Node","type":"string"},"itemId":{"description":"Unique ID of the item that was changed","example":"19084f81-5668-41ee-adbe-295e4c65531a","type":"string"},"auditType":{"description":"Type of change event","enum":["change","create","delete","action"],"type":"string"},"message":{"description":"Human-readable description of the change","example":"Node license created","type":"string"}},"type":"object"}},"components/schemas/NodeAuditRecord":{"id":"components/schemas/NodeAuditRecord","kind":"json-schema","title":"NodeAuditRecord","data":{"description":"A node audit event","properties":{"uid":{"description":"Unique identifier","type":"string"},"org":{"description":"Organization ID","type":"string"},"timestamp":{"description":"Timestamp of the event (ISO 8601)","example":"2024-10-21T17:35:26Z","type":"string"},"category":{"description":"Event category","example":"Node Action","type":"string"},"expires":{"description":"Unix epoch timestamp (seconds) when this audit record expires","type":"integer"},"fqdn":{"description":"FQDN of the node","type":"string"},"value":{"description":"Human-readable description of the action taken","type":"string"}},"type":"object"}},"components/schemas/BGPConfig":{"id":"components/schemas/BGPConfig","kind":"json-schema","title":"BGPConfig","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"BGP plugin configuration stored in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config._bgp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a node"},"children":[]}]}]}],"example":{"enabled":true,"id":"10.0.0.1","asn":65001,"client":false,"groups":[{"_id":"8b4f2c9e-4d2a-4b8f-9a7c-1e2d3c4b5a6f","name":"upstream-isp","peers":[{"_id":"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d","name":"isp-router-1","asn":65000,"ip":"10.0.0.254","secret":"shared-md5-secret"}],"imports":[{"_id":"2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e","name":"accept-defaults","match":{"prefixes":[{"_id":"3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f","prefix":"0.0.0.0/0","exact":true}]},"action":{"action":"allow"}}],"exports":[{"_id":"105bee71-5312-4c39-a1de-1dcf348e3f42","name":"cluster-routes","match":{"cluster":true},"action":{"action":"allow","prefixes":[{"_id":"ed5d9187-4270-44db-892d-e2dc8b847a81","prefix":"10.0.200.0/24"}]}}]}]},"properties":{"enabled":{"description":"Whether BGP is enabled on the node","type":"boolean"},"id":{"description":"Router ID for the local BGP speaker","example":"10.0.0.1","type":"string"},"asn":{"description":"Local autonomous system number","example":65001,"minimum":1,"maximum":65534,"type":"integer"},"client":{"description":"Whether the local speaker operates in client mode","type":"boolean"},"groups":{"description":"Configured peer groups","items":{"$ref":"#/components/schemas/BGPPeerGroup"},"type":"array"}},"required":["enabled","id","asn","client","groups"],"title":"BGPConfig","type":"object"}},"components/schemas/BGPConfigUpdate":{"id":"components/schemas/BGPConfigUpdate","kind":"json-schema","title":"BGPConfigUpdate","data":{"additionalProperties":false,"description":"Request body for updating the top-level BGP settings on a node","properties":{"enabled":{"description":"Whether BGP is enabled on the node","type":"boolean"},"id":{"description":"Router ID for the local BGP speaker","example":"10.0.0.1","type":"string"},"asn":{"description":"Local autonomous system number","example":65001,"minimum":1,"maximum":65534,"type":"integer"},"client":{"description":"Whether the local speaker operates in client mode","type":"boolean"}},"required":["enabled","id","asn","client"],"title":"BGPConfigUpdate","type":"object"}},"components/schemas/BGPPeerGroup":{"id":"components/schemas/BGPPeerGroup","kind":"json-schema","title":"BGPPeerGroup","data":{"description":"BGP peer group persisted on a node","properties":{"_id":{"description":"Peer group ID","example":"8b4f2c9e-4d2a-4b8f-9a7c-1e2d3c4b5a6f","type":"string"},"name":{"description":"Unique peer group name","example":"upstream-isp","type":"string"},"peers":{"description":"BGP peers belonging to this group","items":{"$ref":"#/components/schemas/BGPPeer"},"type":"array"},"imports":{"description":"Import policies applied to this peer group","items":{"$ref":"#/components/schemas/BGPImportPolicy"},"type":"array"},"exports":{"description":"Export policies applied to this peer group","items":{"$ref":"#/components/schemas/BGPExportPolicy"},"type":"array"}},"required":["_id","name"],"title":"BGPPeerGroup","type":"object"}},"components/schemas/BGPPeerGroupCreate":{"id":"components/schemas/BGPPeerGroupCreate","kind":"json-schema","title":"BGPPeerGroupCreate","data":{"additionalProperties":false,"properties":{"name":{"description":"Unique peer group name","example":"upstream-isp","type":"string"}},"required":["name"],"title":"BGPPeerGroupCreate","type":"object"}},"components/schemas/BGPPeer":{"id":"components/schemas/BGPPeer","kind":"json-schema","title":"BGPPeer","data":{"description":"Remote BGP peer persisted on a node","properties":{"_id":{"description":"Peer ID","example":"1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d","type":"string"},"name":{"description":"Peer name","example":"isp-router-1","type":"string"},"ip":{"description":"IPv4 address of the remote peer","example":"10.0.0.254","type":"string"},"asn":{"description":"Remote autonomous system number","example":65000,"minimum":1,"maximum":65534,"type":"integer"},"secret":{"description":"Optional MD5 authentication secret","type":"string"}},"required":["_id","name","ip","asn"],"title":"BGPPeer","type":"object"}},"components/schemas/BGPPeerCreate":{"id":"components/schemas/BGPPeerCreate","kind":"json-schema","title":"BGPPeerCreate","data":{"additionalProperties":false,"properties":{"name":{"description":"Peer name","example":"isp-router-1","type":"string"},"ip":{"description":"IPv4 address of the remote peer","example":"10.0.0.254","type":"string"},"asn":{"description":"Remote autonomous system number","example":65000,"minimum":1,"maximum":65534,"type":"integer"},"secret":{"description":"Optional MD5 authentication secret","type":"string"}},"required":["name","ip","asn"],"title":"BGPPeerCreate","type":"object"}},"components/schemas/BGPPeerUpdate":{"id":"components/schemas/BGPPeerUpdate","kind":"json-schema","title":"BGPPeerUpdate","data":{"additionalProperties":false,"properties":{"name":{"description":"Peer name","example":"isp-router-1","type":"string"},"ip":{"description":"IPv4 address of the remote peer","example":"10.0.0.254","type":"string"},"asn":{"description":"Remote autonomous system number","example":65000,"minimum":1,"maximum":65534,"type":"integer"},"secret":{"description":"Optional MD5 authentication secret. Omit to preserve the existing secret.","type":"string"}},"required":["name","ip","asn"],"title":"BGPPeerUpdate","type":"object"}},"components/schemas/BGPImportPolicy":{"id":"components/schemas/BGPImportPolicy","kind":"json-schema","title":"BGPImportPolicy","data":{"description":"Import policy persisted on a BGP peer group","properties":{"_id":{"description":"Import policy ID","example":"2b3c4d5e-6f7a-8b9c-0d1e-2f3a4b5c6d7e","type":"string"},"name":{"description":"Policy name","example":"accept-defaults","type":"string"},"match":{"type":"object","properties":{"prefixes":{"description":"Prefix matchers for this policy","items":{"$ref":"#/components/schemas/BGPImportPrefix"},"type":"array"}},"required":["prefixes"]},"action":{"type":"object","properties":{"action":{"description":"Action for matching routes","enum":["allow","deny"],"type":"string"}},"required":["action"]}},"required":["_id","name","match","action"],"title":"BGPImportPolicy","type":"object"}},"components/schemas/BGPImportPolicyCreate":{"id":"components/schemas/BGPImportPolicyCreate","kind":"json-schema","title":"BGPImportPolicyCreate","data":{"additionalProperties":false,"properties":{"name":{"description":"Policy name","example":"accept-defaults","type":"string"},"action":{"$ref":"#/components/schemas/BGPPolicyAction"}},"required":["name","action"],"title":"BGPImportPolicyCreate","type":"object"}},"components/schemas/BGPImportPolicyUpdate":{"id":"components/schemas/BGPImportPolicyUpdate","kind":"json-schema","title":"BGPImportPolicyUpdate","data":{"additionalProperties":false,"properties":{"name":{"description":"Policy name","example":"accept-defaults","type":"string"},"action":{"$ref":"#/components/schemas/BGPPolicyAction"}},"required":["name","action"],"title":"BGPImportPolicyUpdate","type":"object"}},"components/schemas/BGPImportPrefix":{"id":"components/schemas/BGPImportPrefix","kind":"json-schema","title":"BGPImportPrefix","data":{"description":"Prefix matcher stored under an import policy","properties":{"_id":{"description":"Prefix matcher ID","example":"3c4d5e6f-7a8b-9c0d-1e2f-3a4b5c6d7e8f","type":"string"},"prefix":{"description":"IPv4 CIDR prefix to match","example":"0.0.0.0/0","type":"string"},"exact":{"description":"Require an exact prefix-length match when true","type":"boolean"},"description":{"description":"Optional description for this prefix matcher","type":"string"}},"required":["_id","prefix"],"title":"BGPImportPrefix","type":"object"}},"components/schemas/BGPImportPrefixCreate":{"id":"components/schemas/BGPImportPrefixCreate","kind":"json-schema","title":"BGPImportPrefixCreate","data":{"additionalProperties":false,"properties":{"prefix":{"description":"IPv4 CIDR prefix to match","example":"0.0.0.0/0","type":"string"},"exact":{"description":"Require an exact prefix-length match when true","type":"boolean"},"description":{"description":"Optional description for this prefix matcher","type":"string"}},"required":["prefix"],"title":"BGPImportPrefixCreate","type":"object"}},"components/schemas/BGPImportPrefixUpdate":{"id":"components/schemas/BGPImportPrefixUpdate","kind":"json-schema","title":"BGPImportPrefixUpdate","data":{"additionalProperties":false,"properties":{"prefix":{"description":"IPv4 CIDR prefix to match","example":"0.0.0.0/0","type":"string"},"exact":{"description":"Require an exact prefix-length match when true","type":"boolean"},"description":{"description":"Optional description for this prefix matcher","type":"string"}},"required":["prefix"],"title":"BGPImportPrefixUpdate","type":"object"}},"components/schemas/BGPExportPolicy":{"id":"components/schemas/BGPExportPolicy","kind":"json-schema","title":"BGPExportPolicy","data":{"description":"Export policy persisted on a BGP peer group","properties":{"_id":{"description":"Export policy ID","example":"105bee71-5312-4c39-a1de-1dcf348e3f42","type":"string"},"name":{"description":"Policy name","example":"cluster-routes","type":"string"},"match":{"type":"object","properties":{"cluster":{"description":"Export only while the node is the active cluster member when true","type":"boolean"}},"required":["cluster"]},"action":{"type":"object","properties":{"action":{"description":"Action for matching exports","enum":["allow","deny"],"type":"string"},"prefixes":{"description":"Prefixes attached to the export action","items":{"$ref":"#/components/schemas/BGPExportPrefix"},"type":"array"}},"required":["action","prefixes"]}},"required":["_id","name","match","action"],"title":"BGPExportPolicy","type":"object"}},"components/schemas/BGPExportPolicyCreate":{"id":"components/schemas/BGPExportPolicyCreate","kind":"json-schema","title":"BGPExportPolicyCreate","data":{"additionalProperties":false,"properties":{"name":{"description":"Policy name","example":"cluster-routes","type":"string"},"match":{"$ref":"#/components/schemas/BGPExportPolicyMatch"},"action":{"$ref":"#/components/schemas/BGPPolicyAction"}},"required":["name","action"],"title":"BGPExportPolicyCreate","type":"object"}},"components/schemas/BGPExportPolicyUpdate":{"id":"components/schemas/BGPExportPolicyUpdate","kind":"json-schema","title":"BGPExportPolicyUpdate","data":{"additionalProperties":false,"properties":{"name":{"description":"Policy name","example":"cluster-routes","type":"string"},"match":{"$ref":"#/components/schemas/BGPExportPolicyMatch"},"action":{"$ref":"#/components/schemas/BGPPolicyAction"}},"required":["name","action"],"title":"BGPExportPolicyUpdate","type":"object"}},"components/schemas/BGPExportPrefix":{"id":"components/schemas/BGPExportPrefix","kind":"json-schema","title":"BGPExportPrefix","data":{"description":"Prefix entry stored under an export policy action","properties":{"_id":{"description":"Export prefix ID","example":"ed5d9187-4270-44db-892d-e2dc8b847a81","type":"string"},"prefix":{"description":"IPv4 CIDR prefix to export","example":"10.0.200.0/24","type":"string"},"description":{"description":"Optional description for this export prefix","type":"string"}},"required":["_id","prefix"],"title":"BGPExportPrefix","type":"object"}},"components/schemas/BGPExportPrefixCreate":{"id":"components/schemas/BGPExportPrefixCreate","kind":"json-schema","title":"BGPExportPrefixCreate","data":{"additionalProperties":false,"properties":{"prefix":{"description":"IPv4 CIDR prefix to export","example":"10.0.200.0/24","type":"string"},"description":{"description":"Optional description for this export prefix","type":"string"}},"required":["prefix"],"title":"BGPExportPrefixCreate","type":"object"}},"components/schemas/BGPExportPrefixUpdate":{"id":"components/schemas/BGPExportPrefixUpdate","kind":"json-schema","title":"BGPExportPrefixUpdate","data":{"additionalProperties":false,"properties":{"prefix":{"description":"IPv4 CIDR prefix to export","example":"10.0.200.0/24","type":"string"},"description":{"description":"Optional description for this export prefix","type":"string"}},"required":["prefix"],"title":"BGPExportPrefixUpdate","type":"object"}},"components/schemas/BGPExportPolicyMatch":{"id":"components/schemas/BGPExportPolicyMatch","kind":"json-schema","title":"BGPExportPolicyMatch","data":{"additionalProperties":false,"properties":{"cluster":{"description":"Export only while the node is the active cluster member when true","type":"boolean"}},"title":"BGPExportPolicyMatch","type":"object"}},"components/schemas/BGPPolicyAction":{"id":"components/schemas/BGPPolicyAction","kind":"json-schema","title":"BGPPolicyAction","data":{"additionalProperties":false,"properties":{"action":{"description":"Policy decision for matching routes or exports","enum":["allow","deny"],"type":"string"}},"required":["action"],"title":"BGPPolicyAction","type":"object"}},"components/schemas/Certificate":{"id":"components/schemas/Certificate","kind":"json-schema","title":"Certificate","data":{"description":"TLS certificate managed by the Trustgrid platform","properties":{"expiresAt":{"description":"Unix timestamp (seconds) when the certificate expires","type":"number"},"fqdn":{"description":"Fully qualified domain name the certificate covers","example":"mynode.trustgrid.io","type":"string"},"orgId":{"description":"Organization ID that owns this certificate","example":"aad89024-5927-4ebd-97e2-3cc605c1da5f","type":"string"},"warning":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Warning status for the certificate. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"none"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means healthy; other values indicate expiration proximity or issues."},"children":[]}]}]}],"example":"none","type":"string"}},"title":"Certificate","type":"object"}},"components/schemas/CertificateParts":{"id":"components/schemas/CertificateParts","kind":"json-schema","title":"CertificateParts","data":{"description":"CertificateParts","properties":{"chain":{"description":"Certificate chain in PEM format","type":"string"},"private_key":{"description":"Private key for the certificate in PEM format","type":"string"}},"required":["chain","private_key"],"title":"CertificateParts","type":"object"}},"components/schemas/ContainerImageRecord":{"id":"components/schemas/ContainerImageRecord","kind":"json-schema","title":"ContainerImageRecord","data":{"description":"Cached container image reference","properties":{"name":{"description":"Image repository or name","example":"mycontainer","type":"string"},"tag":{"description":"Image tag","example":"latest","type":"string"}},"required":["name","tag"],"title":"ContainerImageRecord","type":"object"}},"components/schemas/ContainerRuntimeStatus":{"id":"components/schemas/ContainerRuntimeStatus","kind":"json-schema","title":"ContainerRuntimeStatus","data":{"description":"Runtime status for a container service on a node","properties":{"status":{"description":"Current container runtime state","enum":["INITIALIZING","RUNNING","STOPPED"],"type":"string"},"imageName":{"description":"Resolved image name for the running container","example":"mycontainer/latest","type":"string"},"imageId":{"description":"Resolved image identifier for the running container","example":"a1b2c3d4e5f6","type":"string"}},"title":"ContainerRuntimeStatus","type":"object"}},"components/schemas/ClusterModel":{"id":"components/schemas/ClusterModel","kind":"json-schema","title":"ClusterModel","data":{"properties":{"config":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cluster-wide configuration. Mirrors the subset of node configuration sections that are shared across cluster members. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/cluster/{clusterFQDN}/config/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoints to modify individual sections rather than editing this object directly."},"children":[]}]}]}],"type":"object","properties":{"exec":{"$ref":"#/components/schemas/NodeExecConfig"},"vpn":{"$ref":"#/components/schemas/NodeVpnConfig"},"network":{"$ref":"#/components/schemas/NodeNetworkConfig"},"services":{"$ref":"#/components/schemas/NodeServicesConfig"},"connectors":{"$ref":"#/components/schemas/NodeConnectorsConfig"},"apigw":{"description":"API gateway configuration","type":"object","additionalProperties":true},"core":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Opaque core platform configuration — a free-form map of string keys to values"},"children":[]}]}]}],"type":"object","additionalProperties":true}}},"domain":{"description":"Cluster domain","type":"string"},"fqdn":{"description":"Cluster FQDN","type":"string"},"health":{"description":"Cluster health","enum":["healthy","unhealthy","offline","unknown"],"type":"string"},"mode":{"description":"Cluster Failback Mode","enum":["autoFailback","manualFailback"],"type":"string"},"name":{"description":"Cluster name","type":"string"},"org":{"description":"Organization ID (UUID) that owns this cluster","type":"string"},"tags":{"description":"User-defined tags for organizing and filtering clusters","type":"object","additionalProperties":{"type":"string"}},"tgTags":{"description":"System-managed tags assigned by the Trustgrid platform (read-only)","type":"object","additionalProperties":{"type":"string"}},"tgrn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trustgrid Resource Name for this cluster. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgrn:tg::nodes:cluster/{fqdn}"},"children":[]}]}]}],"example":"tgrn:tg::nodes:cluster/mycluster.myorg.trustgrid.io","type":"string"},"created_at":{"description":"Unix timestamp (seconds) when the cluster was created","type":"integer"},"lifecycleState":{"description":"Operational lifecycle state of the cluster","enum":["pre-production","production","maintenance","decommissioned"],"type":"string"}},"title":"ClusterModel","type":"object"}},"components/schemas/ClusterUpgrade":{"id":"components/schemas/ClusterUpgrade","kind":"json-schema","title":"ClusterUpgrade","data":{"description":"ClusterUpgrade","properties":{"error":{"description":"Error message","type":"string"},"fqdn":{"description":"Cluster FQDN","example":"mycluster.trustgrid.io","type":"string"},"nodeUpgrades":{"items":{"$ref":"#/components/schemas/NodeUpgrade"},"type":"array"},"state":{"description":"Upgrade state","type":"string"},"tags":{"additionalProperties":{"description":"Tag values","type":"string"},"description":"Cluster tags","type":"object"}},"title":"ClusterUpgrade","type":"object"}},"components/schemas/EdgeConnector":{"id":"components/schemas/EdgeConnector","kind":"json-schema","title":"EdgeConnector","data":{"example":{"description":"My connector","enabled":true,"localIp":"100.100.64.1","maxmbps":100,"nic":"eth0","node":"node1","port":1234,"index":1,"protocol":"tcp","service":"ssh"},"properties":{"description":{"description":"connector description","type":"string"},"enabled":{"description":"whether connector is enabled","type":"boolean"},"index":{"description":"Sorting index for the connector","type":"number"},"localIp":{"description":"local IP address","type":"string"},"maxmbps":{"description":"maximum bandwidth in Mbps","type":"number"},"nic":{"description":"network interface name","type":"string"},"node":{"description":"node name","type":"string"},"port":{"description":"connector port","type":"number"},"protocol":{"description":"connector protocol","enum":["udp","tcp","tftp","ftp"],"type":"string"},"service":{"description":"service name","type":"string"},"sourceBlock":{"description":"if provided, only traffic from this CIDR block will be allowed","type":"string"}},"required":["node","port","protocol","service"]}},"components/schemas/NodeFlowEntry":{"id":"components/schemas/NodeFlowEntry","kind":"json-schema","title":"NodeFlowEntry","data":{"type":"object","description":"A single active network flow entry","properties":{"sip":{"type":"string","description":"Source IP address"},"dip":{"type":"string","description":"Destination IP address"},"p":{"type":"string","description":"Protocol (tcp, udp, icmp)"},"sport":{"type":"integer","description":"Source port (TCP/UDP only)"},"dport":{"type":"integer","description":"Destination port (TCP/UDP only)"},"lid":{"type":"integer","description":"Local ICMP identifier (ICMP only)"},"nid":{"type":"integer","description":"NAT ICMP identifier (ICMP only)"},"state":{"type":"string","description":"TCP connection state or ESTABLISHED"},"br":{"type":"integer","description":"Bytes read (received)"},"bw":{"type":"integer","description":"Bytes written (sent)"},"con":{"type":"integer","description":"Connection duration in seconds"},"def":{"type":"boolean","description":"True if the flow is defunct"},"flg":{"type":"integer","description":"TCP flag bits at time of becoming defunct"},"meta":{"type":"object","additionalProperties":true,"description":"Additional metadata if present"}}}},"components/schemas/NodeTriggerContainerActionRequest":{"id":"components/schemas/NodeTriggerContainerActionRequest","kind":"json-schema","title":"NodeTriggerContainerActionRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{event}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to a container service name and you want to start or stop that service."},"children":[]}]}]}],"additionalProperties":false,"properties":{"cmd_action":{"description":"Container service action to execute","enum":["start","stop"],"type":"string"},"name":{"description":"Optional container service name echoed by some clients","example":"mycontainer","type":"string"}},"required":["cmd_action"],"title":"NodeTriggerContainerActionRequest","type":"object"}},"components/schemas/NodeTriggerContainerActionResponse":{"id":"components/schemas/NodeTriggerContainerActionResponse","kind":"json-schema","title":"NodeTriggerContainerActionResponse","data":{"description":"Response returned by a container start or stop request","properties":{"message":{"description":"Human-readable service response message","example":"Successful start","type":"string"}},"title":"NodeTriggerContainerActionResponse","type":"object"}},"components/schemas/NodeTriggerContainerImageDeleteResponse":{"id":"components/schemas/NodeTriggerContainerImageDeleteResponse","kind":"json-schema","title":"NodeTriggerContainerImageDeleteResponse","data":{"description":"Response returned after attempting to delete a cached image","properties":{"success":{"description":"Success message when the image delete completed","example":"Successful deletion","type":"string"},"error":{"description":"Error message when the image could not be deleted","example":"Unable to delete image because it is currently in use","type":"string"}},"title":"NodeTriggerContainerImageDeleteResponse","type":"object"}},"components/schemas/NodeTriggerContainerImageListResponse":{"id":"components/schemas/NodeTriggerContainerImageListResponse","kind":"json-schema","title":"NodeTriggerContainerImageListResponse","data":{"description":"Cached container images available on the node","properties":{"images":{"items":{"$ref":"#/components/schemas/ContainerImageRecord"},"type":"array"}},"title":"NodeTriggerContainerImageListResponse","type":"object"}},"components/schemas/NodeTriggerContainerImageRequest":{"id":"components/schemas/NodeTriggerContainerImageRequest","kind":"json-schema","title":"NodeTriggerContainerImageRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{event}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"container-image"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to list cached images or delete one cached image."},"children":[]}]}]}],"oneOf":[{"type":"object","additionalProperties":false,"properties":{"action":{"description":"Image management action","enum":["list"],"type":"string"}},"required":["action"]},{"type":"object","additionalProperties":false,"properties":{"action":{"description":"Image management action","enum":["delete"],"type":"string"},"image":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Image reference to delete, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repository/tag"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"mycontainer/latest","type":"string"}},"required":["action","image"]}],"title":"NodeTriggerContainerImageRequest","type":"object"}},"components/schemas/NodeTriggerContainerStatusRequest":{"id":"components/schemas/NodeTriggerContainerStatusRequest","kind":"json-schema","title":"NodeTriggerContainerStatusRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{event}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"container-status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve the runtime status of one container or all containers."},"children":[]}]}]}],"additionalProperties":false,"properties":{"container":{"description":"Optional container service name to filter the response","example":"mycontainer","type":"string"}},"title":"NodeTriggerContainerStatusRequest","type":"object"}},"components/schemas/NodeTriggerContainerStatusResponse":{"id":"components/schemas/NodeTriggerContainerStatusResponse","kind":"json-schema","title":"NodeTriggerContainerStatusResponse","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map of container service name to runtime status details. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"container"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, the response typically contains a single entry."},"children":[]}]}]}],"additionalProperties":{"$ref":"#/components/schemas/ContainerRuntimeStatus"},"title":"NodeTriggerContainerStatusResponse","type":"object"}},"components/schemas/NodeTriggerBGPRequest":{"id":"components/schemas/NodeTriggerBGPRequest","kind":"json-schema","title":"NodeTriggerBGPRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body used when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{event}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"bgp"},"children":[]}]}]}],"oneOf":[{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["bgp"]},"action":{"description":"Retrieve BGP runtime status from the node","type":"string","enum":["get"]}},"required":["name","action"]},{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","enum":["bgp"]},"action":{"description":"Restart the BGP service on the node","type":"string","enum":["restart"]}},"required":["name","action"]}],"title":"NodeTriggerBGPRequest","type":"object"}},"components/schemas/NodeTriggerBGPRestartResponse":{"id":"components/schemas/NodeTriggerBGPRestartResponse","kind":"json-schema","title":"NodeTriggerBGPRestartResponse","data":{"description":"Response returned after restarting the BGP service","properties":{"status":{"description":"Human-readable restart status","example":"restarted","type":"string"},"error":{"description":"Error returned when the restart request fails","type":"string"}},"title":"NodeTriggerBGPRestartResponse","type":"object"}},"components/schemas/NodeTriggerBGPRoute":{"id":"components/schemas/NodeTriggerBGPRoute","kind":"json-schema","title":"NodeTriggerBGPRoute","data":{"description":"Learned route reported by a BGP peer","properties":{"dest":{"description":"Destination IPv4 CIDR","example":"10.0.200.0/24","type":"string"},"metric":{"description":"Route metric reported by the node","example":100,"type":"integer"}},"required":["dest","metric"],"title":"NodeTriggerBGPRoute","type":"object"}},"components/schemas/NodeTriggerBGPRejectedRoute":{"id":"components/schemas/NodeTriggerBGPRejectedRoute","kind":"json-schema","title":"NodeTriggerBGPRejectedRoute","data":{"description":"Route rejected by the BGP policy engine","properties":{"dest":{"description":"Destination IPv4 CIDR that was rejected","example":"0.0.0.0/0","type":"string"},"reason":{"description":"Reason the route was rejected","example":"denied by import policy","type":"string"},"group":{"description":"Peer group associated with the rejection, when present","example":"upstream-isp","type":"string"}},"required":["dest","reason"],"title":"NodeTriggerBGPRejectedRoute","type":"object"}},"components/schemas/NodeTriggerBGPAdvertisedPrefix":{"id":"components/schemas/NodeTriggerBGPAdvertisedPrefix","kind":"json-schema","title":"NodeTriggerBGPAdvertisedPrefix","data":{"description":"Prefix currently advertised to a BGP peer","properties":{"prefix":{"description":"Advertised IPv4 CIDR prefix","example":"10.0.200.0/24","type":"string"}},"required":["prefix"],"title":"NodeTriggerBGPAdvertisedPrefix","type":"object"}},"components/schemas/NodeTriggerBGPPeerStatus":{"id":"components/schemas/NodeTriggerBGPPeerStatus","kind":"json-schema","title":"NodeTriggerBGPPeerStatus","data":{"description":"Runtime state of one BGP peer session","properties":{"connected":{"description":"Whether the peer session is established","type":"boolean"},"connectTime":{"description":"Seconds since the peer session connected","type":"integer"},"routes":{"description":"Routes learned from this peer","items":{"$ref":"#/components/schemas/NodeTriggerBGPRoute"},"type":"array"},"rejections":{"description":"Routes rejected from this peer","items":{"$ref":"#/components/schemas/NodeTriggerBGPRejectedRoute"},"type":"array"},"asn":{"description":"Remote autonomous system number","type":"integer"},"advertised":{"description":"Prefixes currently advertised to this peer","items":{"$ref":"#/components/schemas/NodeTriggerBGPAdvertisedPrefix"},"type":"array"},"ip":{"description":"Remote peer IPv4 address","type":"string"}},"required":["connected","routes","rejections","asn","advertised","ip"],"title":"NodeTriggerBGPPeerStatus","type":"object"}},"components/schemas/NodeTriggerBGPGetResponse":{"id":"components/schemas/NodeTriggerBGPGetResponse","kind":"json-schema","title":"NodeTriggerBGPGetResponse","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Runtime BGP status returned by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"event=bgp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action=get"},"children":[]}]}]}],"properties":{"router":{"type":"object","properties":{"router":{"description":"Local BGP speaker's router-id (BGP \"ID\")","example":"10.0.0.1","type":"string"},"peers":{"description":"Runtime peer session state for the local BGP speaker","items":{"$ref":"#/components/schemas/NodeTriggerBGPPeerStatus"},"type":"array"}},"required":["router","peers"]},"error":{"description":"Error returned when runtime BGP status cannot be fetched","type":"string"}},"required":["router"],"title":"NodeTriggerBGPGetResponse","type":"object"}},"components/schemas/ConnectorConfig":{"id":"components/schemas/ConnectorConfig","kind":"json-schema","title":"ConnectorConfig","data":{"example":{"connectors":[{"description":"My connector","enabled":true,"id":"1e1d36b2-63b6-46bb-8334-a80a828afb5e","localIp":"100.100.64.1","maxmbps":100,"nic":"eth0","node":"node1","port":1234,"protocol":"tcp","service":"ssh"}]},"properties":{"connectors":{"items":{"properties":{"description":{"description":"connector description","type":"string"},"enabled":{"description":"whether connector is enabled","type":"boolean"},"id":{"description":"unique ID of connector","type":"string"},"localIp":{"description":"local IP address","type":"string"},"maxmbps":{"description":"maximum bandwidth in Mbps","type":"number"},"nic":{"description":"network interface name","type":"string"},"node":{"description":"node name","type":"string"},"port":{"description":"connector port","type":"number"},"protocol":{"description":"connector protocol","enum":["udp","tcp","tftp","ftp"],"type":"string"},"service":{"description":"service name","type":"string"},"sourceBlock":{"description":"if provided, only traffic from this CIDR block will be allowed","type":"string"}},"required":["id","node","port","protocol","service"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/Container":{"id":"components/schemas/Container","kind":"json-schema","title":"Container","data":{"description":"Container","properties":{"command":{"description":"Command to run in the container","type":"string"},"description":{"description":"Container description","example":"my container","type":"string"},"enabled":{"type":"boolean"},"execType":{"description":"Execution type","enum":["onDemand","service","recurring"],"type":"string"},"hostname":{"description":"Container hostname","example":"mycontainer","type":"string"},"id":{"description":"Container ID","example":"b4011aa3-d0d5-4c5c-9c0b-19095ba515d5","type":"string"},"image":{"$ref":"#/components/schemas/Image"},"name":{"description":"Container name","example":"mycontainer","type":"string"},"privileged":{"description":"Run the container as a privileged user","type":"boolean"},"requireConnectivity":{"description":"Only start the container if the node has connectivity to the control plane. Needed for encrypted volumes.","type":"boolean"},"stopTime":{"description":"Grace period for container to stop when requested, in seconds","example":"60","type":"string"},"useInit":{"description":"Indicates that an init process should be used as PID 1 in the container. Ensures responsibilities of an init system are performed inside the container (e.g., handling exit signals).","type":"boolean"},"user":{"description":"User name (or UID) and optionally the group (or GID) to use when starting the container.  This will override the USER specified in the image","type":"string"},"nodeUid":{"description":"UUID of the node this container is configured on","type":"string"},"namespace":{"description":"Container namespace, typically \"exec\"","type":"string"},"saveOutput":{"description":"Whether to persist stdout/stderr from on-demand container runs","type":"boolean"}},"title":"Container","type":"object"}},"components/schemas/ContainerCapabilities":{"id":"components/schemas/ContainerCapabilities","kind":"json-schema","title":"Container Capabilities","data":{"description":"Container Capabilities","properties":{"addCaps":{"items":{"description":"Added capabilities","type":"string"},"type":"array"},"dropCaps":{"items":{"description":"Dropped capabilities","type":"string"},"type":"array"}},"title":"Container Capabilities","type":"object"}},"components/schemas/ContainerConfig":{"id":"components/schemas/ContainerConfig","kind":"json-schema","title":"ContainerConfig","data":{"description":"ContainerConfig","properties":{"capabilities":{"$ref":"#/components/schemas/ContainerCapabilities"},"healthCheck":{"$ref":"#/components/schemas/ContainerHealthCheck"},"interfaces":{"items":{"$ref":"#/components/schemas/ContainerInterfaces"},"type":"array"},"limits":{"$ref":"#/components/schemas/ContainerLimits"},"logging":{"$ref":"#/components/schemas/ContainerLogging"},"mounts":{"items":{"$ref":"#/components/schemas/ContainerMount"},"type":"array"},"portMappings":{"items":{"$ref":"#/components/schemas/ContainerPortMapping"},"type":"array"},"variables":{"items":{"$ref":"#/components/schemas/ContainerVariable"},"type":"array"},"virtualNetworks":{"items":{"$ref":"#/components/schemas/ContainerVirtualNetwork"},"type":"array"},"vrf":{"$ref":"#/components/schemas/ContainerVRF"}},"title":"ContainerConfig","type":"object"}},"components/schemas/ContainerHealthCheck":{"id":"components/schemas/ContainerHealthCheck","kind":"json-schema","title":"Container Health Check","data":{"description":"Container Health Check","properties":{"command":{"description":"Command","example":"/bin/sh -c 'exit 0'","type":"string"},"interval":{"description":"Interval","example":10,"type":"number"},"retries":{"default":3,"description":"Number of health check retries before a container is marked unhealthy","example":10,"type":"number"},"startPeriod":{"description":"Grace period before health checks are monitored, in seconds","example":10,"type":"number"},"timeout":{"description":"Timeout","example":10,"type":"number"}},"title":"Container Health Check","type":"object"}},"components/schemas/ContainerInterfaces":{"id":"components/schemas/ContainerInterfaces","kind":"json-schema","title":"Container Interfaces","data":{"description":"Container Interfaces","properties":{"dest":{"description":"Destination","example":"10.10.14.0/24","type":"string"},"name":{"description":"Interface name","example":"eth0","type":"string"},"uid":{"description":"UID","example":"7da978ea-3d64-470a-8494-20ca4981e184","type":"string"}},"title":"Container Interfaces","type":"object"}},"components/schemas/ContainerLimits":{"id":"components/schemas/ContainerLimits","kind":"json-schema","title":"Container Limits","data":{"description":"Container Limits","properties":{"cpuMax":{"description":"CPU max","example":80,"type":"number"},"ioRbps":{"description":"IO read rate","example":80,"type":"number"},"ioRiops":{"description":"IO read IOPS","example":80,"type":"number"},"ioWbps":{"description":"IO write rate","example":80,"type":"number"},"ioWiops":{"description":"IO write IOPS","example":80,"type":"number"},"legacyMemHigh":{"description":"Legacy memory high","example":80,"type":"number"},"legacyMemMax":{"description":"Legacy memory max","example":80,"type":"number"},"limits":{"items":{"description":"Limit","properties":{"hard":{"description":"Hard limit","example":20,"type":"number"},"soft":{"description":"Soft limit","example":10,"type":"number"},"type":{"description":"Limit type","enum":["core","cpu","data","fsize","locks","memlock","msgqueue","nice","nofile","nproc","rss","rtprio","rttime","sigpending","stack"],"type":"string"}},"type":"object"},"type":"array"},"memHigh":{"description":"Memory high","example":80,"type":"number"},"memMax":{"description":"Memory max","example":80,"type":"number"}},"title":"Container Limits","type":"object"}},"components/schemas/ContainerLogging":{"id":"components/schemas/ContainerLogging","kind":"json-schema","title":"Container Logging","data":{"description":"Container Logging","properties":{"maxFileSize":{"description":"Maximum file size in MB","example":10,"type":"number"},"numFiles":{"description":"Maximum number of files","example":10,"type":"number"}},"title":"Container Logging","type":"object"}},"components/schemas/ContainerMount":{"id":"components/schemas/ContainerMount","kind":"json-schema","title":"Container Mount","data":{"description":"Container Mount","properties":{"dest":{"description":"Destination","example":"/myvolume","type":"string"},"encrypted":{"description":"Encrypted","type":"boolean"},"mountType":{"description":"Mount type","enum":["volume","bind"],"type":"string"},"source":{"description":"Source","example":"myvolume","type":"string"},"uid":{"description":"UID","example":"3ae09040-396e-4a7a-a3b7-dfb99a241685","type":"string"}},"title":"Container Mount","type":"object"}},"components/schemas/ContainerPortMapping":{"id":"components/schemas/ContainerPortMapping","kind":"json-schema","title":"Container Port Mapping","data":{"description":"Container Port Mapping","properties":{"containerPort":{"description":"Container port","example":"8080","type":"string"},"hostPort":{"description":"Host port","example":"8080","type":"string"},"iface":{"description":"Interface","example":"eth0","type":"string"},"protocol":{"description":"Protocol","enum":["tcp","udp"],"type":"string"},"uid":{"description":"UID","example":"d0522f1b-cc1a-4aad-bb46-99304a5e152d","type":"string"}},"title":"Container Port Mapping","type":"object"}},"components/schemas/ContainerVRF":{"id":"components/schemas/ContainerVRF","kind":"json-schema","title":"Container VRF","data":{"description":"Container VRF","properties":{"name":{"description":"VRF name","example":"myvrf","type":"string"}},"title":"Container VRF","type":"object"}},"components/schemas/ContainerVariable":{"id":"components/schemas/ContainerVariable","kind":"json-schema","title":"Container Variable","data":{"description":"Container Variable","properties":{"name":{"description":"Variable name","example":"myvar","type":"string"},"value":{"description":"Variable value","example":"myvalue","type":"string"}},"title":"Container Variable","type":"object"}},"components/schemas/ContainerVirtualNetwork":{"id":"components/schemas/ContainerVirtualNetwork","kind":"json-schema","title":"Container Virtual Network","data":{"description":"Container Virtual Network","properties":{"allowOutbound":{"description":"Allow outbound traffic","type":"boolean"},"ip":{"description":"Virtual IP","example":"10.10.10.14","type":"string"},"network":{"description":"Network name","example":"mynetwork","type":"string"},"uid":{"description":"UID","example":"59349874-2e2a-4c51-b864-2782a3a489af","type":"string"}},"title":"Container Virtual Network","type":"object"}},"components/schemas/CreateClusterModel":{"id":"components/schemas/CreateClusterModel","kind":"json-schema","title":"CreateClusterModel","data":{"properties":{"name":{"description":"Cluster name","type":"string"}},"required":["name"],"title":"CreateClusterModel","type":"object"}},"components/schemas/DataStoreFile":{"id":"components/schemas/DataStoreFile","kind":"json-schema","title":"Data Store File","data":{"description":"Data Store File","properties":{"files":{"description":"Children, if a directory. This is a recursive model.","type":"string"},"name":{"description":"File name","example":"win2019-serverli.qcow2","type":"string"},"path":{"description":"File path","example":"qcows/win2019-serverli.qcow2","type":"string"},"size":{"description":"File size","example":"9.4 GB","type":"string"},"type":{"description":"File type","enum":["file","directory"],"type":"string"}},"title":"Data Store File","type":"object"}},"components/schemas/DataStoreTask":{"id":"components/schemas/DataStoreTask","kind":"json-schema","title":"DataStoreTask","data":{"description":"DataStoreTask","properties":{"details":{"description":"Task details","example":"Finished the file transfer","type":"string"},"eTime":{"description":"End timestamp","example":1667861503331,"type":"number"},"id":{"description":"ID","example":"0d7f7145-32bd-45e9-ac4b-9cf04887392","type":"string"},"name":{"description":"Task name","example":"Upload S3 File","type":"string"},"sTime":{"description":"Start timestamp","example":1667861503331,"type":"number"},"status":{"description":"Task status","example":"Completed","type":"string"}},"title":"DataStoreTask","type":"object"}},"components/schemas/VirtualNetworkAccessPolicy":{"id":"components/schemas/VirtualNetworkAccessPolicy","kind":"json-schema","title":"Virtual Network Access Policy","data":{"description":"Virtual Network Access Policy","properties":{"uid":{"description":"Unique identifier (UUID)","type":"string"},"action":{"description":"Whether traffic matching this policy is allowed or denied","type":"string","enum":["allow","deny"]},"source":{"description":"Source CIDR","type":"string"},"dest":{"description":"Destination CIDR","type":"string"},"notDest":{"description":"Invert the destination match","type":"boolean"},"protocol":{"description":"Protocol","enum":["any","tcp","udp","icmp"],"type":"string"},"ports":{"description":"Port or port range (empty string means all ports)","type":"string"},"description":{"type":"string"},"lineNumber":{"description":"Display order position of this policy rule","type":"integer"},"networkName":{"description":"Virtual network this policy belongs to","type":"string"},"domainName":{"description":"Domain this policy belongs to","type":"string"},"orgId":{"description":"Organization ID","type":"string"},"type":{"description":"Object type discriminator","example":"AccessPolicy","type":"string"}},"required":["protocol","source","dest"],"title":"Virtual Network Access Policy","type":"object"}},"components/schemas/VirtualNetworkAuthorizationGroup":{"id":"components/schemas/VirtualNetworkAuthorizationGroup","kind":"json-schema","title":"Virtual Network Authorization Group","data":{"description":"Virtual Network Authorization Group","properties":{"description":{"type":"string"},"name":{"description":"Group name","type":"string"}},"title":"Virtual Network Authorization Group","type":"object"}},"components/schemas/VirtualNetworkAuthorizationGroupMembership":{"id":"components/schemas/VirtualNetworkAuthorizationGroupMembership","kind":"json-schema","title":"Virtual Network Authorization Group Membership","data":{"description":"Virtual Network Authorization Group Membership","properties":{"description":{"type":"string"},"idp":{"type":"string"},"memberType":{"type":"string"},"name":{"type":"string"},"uid":{"type":"string"}},"title":"Virtual Network Authorization Group Membership","type":"object"}},"components/schemas/VirtualNetworkDNSConfiguration":{"id":"components/schemas/VirtualNetworkDNSConfiguration","kind":"json-schema","title":"Virtual Network DNS Configuration","data":{"description":"DNS configuration for a virtual network","properties":{"enabled":{"description":"Whether DNS is enabled for the network","type":"boolean"},"server":{"description":"IP address of the DNS server","example":"1.1.1.13","type":"string"},"orgId":{"description":"Organization ID","type":"string"},"networkName":{"description":"Virtual network name this config belongs to","type":"string"},"domainName":{"description":"Domain name this config belongs to","type":"string"},"type":{"description":"Object type discriminator","example":"DNSConfig","type":"string"}},"title":"Virtual Network DNS Configuration","type":"object"}},"components/schemas/VirtualNetworkDNSRecord":{"id":"components/schemas/VirtualNetworkDNSRecord","kind":"json-schema","title":"Virtual Network DNS Record","data":{"description":"Virtual Network DNS Record","properties":{"name":{"type":"string"},"recordType":{"type":"string"},"ttl":{"type":"number"},"value":{"type":"string"}},"title":"Virtual Network DNS Record","type":"object"}},"components/schemas/VirtualNetworkDNSZone":{"id":"components/schemas/VirtualNetworkDNSZone","kind":"json-schema","title":"Virtual Network DNS Zone","data":{"description":"Virtual Network DNS Zone","properties":{"name":{"description":"DNS zone name (e.g. \"test.com\")","type":"string"},"description":{"type":"string"},"resolver":{"description":"Custom resolver IP (if set)","type":"string"},"networkName":{"description":"Virtual network this zone belongs to","type":"string"},"domainName":{"description":"Domain this zone belongs to","type":"string"},"orgId":{"description":"Organization ID","type":"string"},"type":{"description":"Object type discriminator","example":"DNSZone","type":"string"}},"title":"Virtual Network DNS Zone","type":"object"}},"components/schemas/VirtualNetworkGroup":{"id":"components/schemas/VirtualNetworkGroup","kind":"json-schema","title":"Virtual Network Group","data":{"description":"Virtual Network Group","properties":{"name":{"description":"Group name","type":"string"},"description":{"type":"string"},"networkName":{"description":"Virtual network this group belongs to","type":"string"},"domainName":{"description":"Domain this group belongs to","type":"string"},"orgId":{"description":"Organization ID","type":"string"},"type":{"description":"Object type discriminator","example":"NetworkGroup","type":"string"}},"title":"Virtual Network Group","type":"object"}},"components/schemas/VirtualNetworkGroupMembership":{"id":"components/schemas/VirtualNetworkGroupMembership","kind":"json-schema","title":"Virtual Network Group Membership","data":{"description":"Membership of a network object in a network group","properties":{"groupName":{"description":"Name of the group this membership belongs to","type":"string"},"objectName":{"description":"Name of the network object that is a member","type":"string"},"networkName":{"description":"Virtual network this membership belongs to","type":"string"},"domainName":{"description":"Domain this membership belongs to","type":"string"},"orgId":{"description":"Organization ID","type":"string"},"type":{"description":"Object type discriminator","example":"NetworkGroupMembership","type":"string"}},"title":"Virtual Network Group Membership","type":"object"}},"components/schemas/VirtualNetworkInventory":{"id":"components/schemas/VirtualNetworkInventory","kind":"json-schema","title":"Virtual Network Inventory","data":{"description":"Virtual Network Inventory","properties":{"accessPolicies":{"items":{"$ref":"#/components/schemas/VirtualNetworkAccessPolicy"},"type":"array"},"dnsConfig":{"items":{"$ref":"#/components/schemas/VirtualNetworkDNSConfiguration"},"type":"array"},"dnsRecords":{"items":{"$ref":"#/components/schemas/VirtualNetworkDNSRecord"},"type":"array"},"dnsZones":{"items":{"$ref":"#/components/schemas/VirtualNetworkDNSZone"},"type":"array"},"networkGroupMemberships":{"items":{"$ref":"#/components/schemas/VirtualNetworkGroupMembership"},"type":"array"},"networkGroups":{"items":{"$ref":"#/components/schemas/VirtualNetworkGroup"},"type":"array"},"networkObjects":{"items":{"$ref":"#/components/schemas/VirtualNetworkObject"},"type":"array"},"routes":{"items":{"$ref":"#/components/schemas/VirtualNetworkRoute"},"type":"array"}},"title":"Virtual Network Inventory","type":"object"}},"components/schemas/VirtualNetworkObject":{"id":"components/schemas/VirtualNetworkObject","kind":"json-schema","title":"Virtual Network Object","data":{"description":"Virtual Network Object (named CIDR for use in access policies)","properties":{"name":{"description":"Object name","type":"string"},"cidr":{"description":"CIDR this object represents","example":"1.2.3.0/24","type":"string"},"description":{"type":"string"},"networkName":{"description":"Virtual network this object belongs to","type":"string"},"domainName":{"description":"Domain this object belongs to","type":"string"},"orgId":{"description":"Organization ID","type":"string"},"type":{"description":"Object type discriminator","example":"NetworkObject","type":"string"}},"title":"Virtual Network Object","type":"object"}},"components/schemas/VirtualNetworkRouteMonitor":{"id":"components/schemas/VirtualNetworkRouteMonitor","kind":"json-schema","title":"VirtualNetworkRouteMonitor","data":{"description":"VirtualNetworkRouteMonitor","properties":{"enabled":{"type":"boolean"},"name":{"type":"string"},"protocol":{"type":"string","enum":["tcp","icmp"]},"dest":{"type":"string"},"port":{"type":"number"},"interval":{"type":"number"},"count":{"type":"number"},"maxLatency":{"type":"number"}},"type":"object"}},"components/schemas/VirtualNetworkRoute":{"id":"components/schemas/VirtualNetworkRoute","kind":"json-schema","title":"VirtualNetworkRoute","data":{"description":"VirtualNetworkRoute","properties":{"description":{"type":"string"},"domainName":{"type":"string"},"metric":{"type":"number"},"networkCidr":{"type":"string"},"networkName":{"type":"string"},"nodeName":{"type":"string"},"uid":{"type":"string"},"monitors":{"items":{"$ref":"#/components/schemas/VirtualNetworkRouteMonitor"},"type":"array"}},"title":"VirtualNetworkRoute","type":"object"}},"components/schemas/EventModel":{"id":"components/schemas/EventModel","kind":"json-schema","title":"Event","data":{"description":"Event","title":"Event","type":"object","properties":{"level":{"description":"Event log level","example":"ERROR","type":"string","enum":["INFO","WARNING","ERROR","CRITICAL"]},"message":{"description":"Event message","example":"Node Disconnected","type":"string"},"timestamp":{"description":"Unix epoch timestamp (seconds) when the event was generated","example":1775196846,"type":"integer"},"receivedTime":{"description":"Unix epoch timestamp (seconds) when the control plane received the event","example":1775196846,"type":"integer"},"subject":{"description":"Event item type","example":"Node","type":"string","enum":["Node","Certificate","Order","Upgrade","AlertSuppression"]},"eventType":{"description":"Event type","example":"Node Connect","type":"string"},"orgId":{"description":"Org ID","example":"0000000-0000-0000-0000-000000000001","type":"string"},"uid":{"description":"Event ID","example":"32Nt3pyfAJisyUADctXZW6bcwJC","type":"string"},"nodeId":{"description":"Node ID (if applicable)","example":"0000000-0000-0000-0000-000000000002","type":"string"},"nodeName":{"description":"Node name (if applicable)","example":"test","type":"string"},"domain":{"description":"Domain name (if applicable)","example":"Domain","type":"string"},"fqdn":{"description":"FQDN (if applicable)","example":"test.dev.io","type":"string"},"orderId":{"description":"Order ID (if applicable)","example":"32Nt3pyfAJisyUADctXZW6bcwJD","type":"string"},"details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata associated to the event. Shape varies by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Values may be strings, numbers, or nested objects."},"children":[]}]}]}],"type":"object","additionalProperties":{}},"state":{"description":"Event state (if applicable)","example":"EXCEEDED","type":"string","enum":["EXCEEDED","CLEARED","UNKNOWN"]}}}},"components/schemas/Group":{"id":"components/schemas/Group","kind":"json-schema","title":"Group","data":{"description":"User group for organizing access permissions","properties":{"uid":{"description":"Group unique identifier (UUID)","type":"string"},"name":{"description":"Group display name","type":"string"},"description":{"type":"string"},"referenceId":{"description":"Internal reference identifier (e.g. \"idp-name group-name\")","type":"string"},"orgId":{"description":"Organization ID","type":"string"},"policyIds":{"description":"Named policies assigned to this group. May be an object map or an array of policy ID strings depending on context.","additionalProperties":{}},"type":{"description":"Object type discriminator","example":"Group","type":"string"}},"type":"object"}},"components/schemas/GroupMember":{"id":"components/schemas/GroupMember","kind":"json-schema","title":"GroupMember","data":{"properties":{"group":{"type":"string"},"user":{"type":"string"}},"type":"object"}},"components/schemas/GroupModel":{"id":"components/schemas/GroupModel","kind":"json-schema","title":"GroupModel","data":{"properties":{"description":{"description":"Group Description","type":"string"},"name":{"description":"Group Name","type":"string"},"uid":{"description":"Group ID","type":"string"}},"title":"GroupModel","type":"object"}},"components/schemas/IdentityProviderModel":{"id":"components/schemas/IdentityProviderModel","kind":"json-schema","title":"IdentityProviderModel","data":{"allOf":[{"$ref":"#/components/schemas/IdentityProviderUpdateModel"},{"properties":{"uid":{"type":"string"}},"type":"object"}]}},"components/schemas/IdentityProviderUpdateModel":{"id":"components/schemas/IdentityProviderUpdateModel","kind":"json-schema","title":"IdentityProviderUpdateModel","data":{"properties":{"clientId":{"type":"string"},"description":{"type":"string"},"name":{"type":"string"},"uri":{"type":"string"}},"type":"object"}},"components/schemas/IdpGroup":{"id":"components/schemas/IdpGroup","kind":"json-schema","title":"IdpGroup","data":{"properties":{"group":{"type":"string"},"groupReferenceId":{"type":"string"},"idp":{"type":"string"}},"type":"object"}},"components/schemas/Image":{"id":"components/schemas/Image","kind":"json-schema","title":"Image","data":{"description":"Image","properties":{"repository":{"description":"Image repository","example":"mycompany.trustgrid.io/myimage","type":"string"},"tag":{"description":"Image tag","example":"latest","type":"string"}},"title":"Image","type":"object"}},"components/schemas/LifecycleStateRequest":{"id":"components/schemas/LifecycleStateRequest","kind":"json-schema","title":"LifecycleStateRequest","data":{"description":"Request body for updating a node's lifecycle state","properties":{"lifecycleState":{"description":"The lifecycle state to set on the node","enum":["pre-production","production","maintenance","decommissioned"],"example":"production","type":"string"}},"required":["lifecycleState"],"title":"LifecycleStateRequest","type":"object"}},"components/schemas/Node":{"id":"components/schemas/Node","kind":"json-schema","title":"Node","data":{"description":"Node","properties":{"cluster":{"description":"Cluster FQDN","example":"mycluster.trustgrid.io","type":"string"},"config":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Node configuration. Each sub-key mirrors an individual "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /node/{nodeID}/config/*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint. In direct single-node responses, this object contains the complete configuration. In list responses, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" may be included when explicitly requested via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"projection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; when returned that way, only the projected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"config"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fields are present."},"children":[]}]}]}],"type":"object","properties":{"gateway":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Gateway configuration — controls whether this node acts as a gateway server accepting client connections, a client connecting to gateway servers, or both."},"children":[]}]}]}],"type":"object","properties":{"enabled":{"description":"Whether the gateway plugin is active on this node","type":"boolean"},"host":{"description":"IP or hostname the gateway server listens on","type":"string"},"port":{"description":"TCP port the gateway server listens on","type":"integer"},"udpPort":{"description":"UDP port for DTLS traffic when UDP is enabled","type":"integer"},"udpEnabled":{"description":"Enable UDP/DTLS transport in addition to TCP","type":"boolean"},"maxmbps":{"description":"Maximum aggregate throughput cap for all connected clients, in Mbps","type":"number"},"maxClientWriteMbps":{"description":"Per-client write throughput cap, in Mbps","type":"number"},"connectToPublic":{"description":"Whether this node connects outbound through the public gateway tier","type":"boolean"},"monitorGateway":{"description":"Enable latency and hop monitoring for gateway connections","type":"boolean"},"master":{"description":"Whether this node is the active master in a cluster gateway pair","type":"boolean"},"mesh":{"description":"Mesh group name if this node participates in a gateway mesh","type":"string"},"cert":{"description":"Name of the TLS certificate used by the gateway server","type":"string"},"paths":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Outbound client paths — connections this node makes to gateway servers"},"children":[]}]}]}],"type":"array","items":{"type":"object","properties":{"id":{"description":"Path identifier (UUID)","type":"string"},"host":{"description":"Gateway server hostname or IP","type":"string"},"port":{"description":"Gateway server TCP port","type":"integer"},"node":{"description":"FQDN of the target gateway server node","type":"string"},"enabled":{"type":"boolean"},"default":{"description":"Whether this is the preferred (default) path","type":"boolean"},"local":{"description":"Local IP to bind when opening this path","type":"string"}}}},"clients":{"description":"Named clients permitted to connect to this gateway server","type":"array","items":{"type":"object","properties":{"name":{"description":"Client node FQDN","type":"string"},"enabled":{"type":"boolean"}}}},"routes":{"description":"Static routes advertised through the gateway","type":"array","items":{"type":"object","properties":{"route":{"description":"CIDR","type":"string"},"dest":{"description":"Destination gateway node FQDN","type":"string"},"metric":{"type":"integer"}}}},"acls":{"description":"Gateway-level access control rules","type":"array","items":{"type":"object","properties":{"source":{"description":"Source CIDR or node FQDN","type":"string"},"dest":{"description":"Destination CIDR or node FQDN","type":"string"}}}}}},"cluster":{"description":"High-availability cluster settings for this node","type":"object","properties":{"enabled":{"description":"Whether cluster mode is active on this node","type":"boolean"},"host":{"description":"IP address used for cluster heartbeat traffic","type":"string"},"port":{"description":"TCP port used for cluster heartbeat communication","type":"integer"},"shared":{"description":"Floating IP address managed by the active cluster master","type":"string"},"master":{"description":"Whether this node is currently the cluster master","type":"boolean"},"statusHost":{"description":"Host used for cluster health-status checks","type":"string"},"statusPort":{"description":"Port used for cluster health-status checks","type":"integer"},"updateTime":{"description":"Unix timestamp of the last cluster config change","type":"integer"},"versionCounter":{"description":"Monotonically increasing config version counter","type":"integer"},"masterVersion":{"description":"Config version currently held by the cluster master","type":"integer"}}},"exec":{"$ref":"#/components/schemas/NodeExecConfig"},"snmp":{"description":"SNMPv3 monitoring agent configuration","type":"object","properties":{"enabled":{"description":"Whether the SNMP agent is running","type":"boolean"},"interface":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Network interface the SNMP agent binds to (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eth0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"port":{"description":"UDP port the SNMP agent listens on (default 161)","type":"integer"},"engineId":{"description":"SNMP engine identifier","type":"string"},"username":{"description":"SNMPv3 username","type":"string"},"authProtocol":{"description":"Authentication hash algorithm","enum":["SHA","MD5"],"type":"string"},"authPassphrase":{"description":"Authentication passphrase","type":"string"},"privacyProtocol":{"description":"Privacy (encryption) algorithm","enum":["AES128","AES192","AES256","DES"],"type":"string"},"privacyPassphrase":{"description":"Privacy passphrase","type":"string"}}},"alert":{"description":"Node-level alert threshold configuration","type":"object","properties":{"enabled":{"description":"Whether alert threshold evaluation is active on this node","type":"boolean"},"thresholds":{"description":"Alert rules evaluated against shadow reported telemetry values","type":"array","items":{"type":"object","properties":{"id":{"description":"Rule ID (UUID)","type":"string"},"name":{"description":"Human-readable rule name","type":"string"},"telemetry":{"description":"Telemetry metric to evaluate","enum":["cpu","ram","disk","heap","embflows","latency","bandwidthIn","bandwidthOut","tcpResets","vpnFlows"],"type":"string"},"max":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upper bound — alert fires when the value exceeds this"},"children":[]}]}]}],"type":"number"},"exceededWindow":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of time units the value must continuously exceed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the alert fires"},"children":[]}]}]}],"type":"number"},"exceededWindowUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time unit for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exceededWindow"},"children":[]}]}]}],"enum":["minutes","hours"],"type":"string"}}}}}},"vpn":{"$ref":"#/components/schemas/NodeVpnConfig"},"dns":{"description":"Local DNS resolver configuration on the node","type":"object","properties":{"enabled":{"description":"Whether the local DNS resolver is active","type":"boolean"},"upstream":{"description":"Upstream DNS server IPs the resolver forwards to","type":"array","items":{"type":"string"}},"records":{"description":"Static DNS records served by the local resolver","type":"array","items":{"type":"object","properties":{"name":{"description":"Hostname for this record","type":"string"}}}}}},"network":{"$ref":"#/components/schemas/NodeNetworkConfig"},"services":{"$ref":"#/components/schemas/NodeServicesConfig"},"connectors":{"$ref":"#/components/schemas/NodeConnectorsConfig"},"_bgp":{"$ref":"#/components/schemas/BGPConfig"},"jvm":{"description":"JVM heap memory settings for embedded Java workloads","type":"object","properties":{"memory":{"type":"object","properties":{"min":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Minimum heap size (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"512m"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1g"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"max":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum heap size (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2g"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"}}}}}}},"name":{"description":"Node name","example":"mynode","type":"string"},"online":{"description":"True when the node is connected to the control plane","type":"boolean"},"shadow":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AWS IoT Device Shadow — the node's desired and reported state store. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a flat key-value map updated by the node itself; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds pending configuration the node has not yet acknowledged (usually empty). Most fields in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" use dot-notation keys. Common "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node-core.version"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (software version), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"memory"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (RAM in MB), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (disk free in GB), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cores"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (CPU count), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dnsResolution"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (\"healthy\"/\"unhealthy\"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repoConnectivity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (\"true\"/\"false\"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"os.distro.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., \"ubuntu\"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ssh.local"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (\"true\"/\"false\"), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"node.upgrade.state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"features"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (object of enabled feature flags), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nic.{name}.mac/mtu/speed/dhcp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (NIC telemetry)."},"children":[]}]}]}],"type":"object","properties":{"desired":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending configuration changes the node has not yet applied. Typically empty; when populated, contents mirror the structure of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reported"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (flat dot-notation key-value map)."},"children":[]}]}]}],"type":"object","additionalProperties":true},"reported":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Live telemetry reported by the node. Keys use dot-notation (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nic.eth0.mtu"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Values may be strings, numbers, or objects."},"children":[]}]}]}],"type":"object","additionalProperties":{}}}},"state":{"description":"Node state","enum":["ACTIVE","INACTIVE"],"type":"string"},"tags":{"description":"User-defined tags for organizing and filtering nodes","type":"object","additionalProperties":{"type":"string"}},"type":{"description":"Device type","enum":["Agent","Node"],"type":"string"},"uid":{"description":"Node ID","example":"19084f81-5668-41ee-adbe-295e4c65531a","type":"string"},"fqdn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Fully qualified domain name, e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mynode.myorg.trustgrid.io"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omitted when projection[] is used without this field."},"children":[]}]}]}],"example":"mynode.myorg.trustgrid.io","type":"string"},"lastip":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last IP address observed when the node connected. Omitted when projection[] is used without this field."},"children":[]}]}]}],"example":"203.0.113.42","type":"string"},"last_connect":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp in milliseconds of the most recent control plane connection. Omitted when projection[] is used without this field."},"children":[]}]}]}],"type":"integer"},"org":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Organization ID (UUID) that owns this node. Returned only by GET /node/{nodeID}."},"children":[]}]}]}],"example":"aad89024-5927-4ebd-97e2-3cc605c1da5f","type":"string"},"domain":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain FQDN this node belongs to. Returned only by GET /node/{nodeID}."},"children":[]}]}]}],"example":"myorg.trustgrid.io","type":"string"},"tgTags":{"description":"System-managed tags assigned by the Trustgrid platform. Read-only; always returned in list and single-node responses.","type":"object","additionalProperties":{"type":"string"}},"keys":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Named cryptographic public keys used for node authentication and WireGuard tunneling. Keyed by purpose (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"wireguard"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"); values are opaque string-encoded public keys. Always returned but rarely needed directly."},"children":[]}]}]}],"type":"object","additionalProperties":{"type":"string"}},"tgrn":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trustgrid Resource Name — a globally unique identifier for this node across the platform. Format: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tgrn:tg::nodes:node/{uid}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Always returned."},"children":[]}]}]}],"example":"tgrn:tg::nodes:node/19084f81-5668-41ee-adbe-295e4c65531a","type":"string"},"created_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp (seconds) when the node was registered. Omitted when projection[] is used without this field."},"children":[]}]}]}],"type":"integer"},"device":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hardware device information detected from the physical or virtual appliance. Omitted when projection[] is used without this field."},"children":[]}]}]}],"type":"object","properties":{"mac":{"description":"MAC address of the primary network interface","type":"string"},"model":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hardware model identifier (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"esx"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kvm"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"vendor":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Hardware vendor name (e.g., "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"vmware"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"}}},"location":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP geolocation derived from the node's last observed IP address. Omitted when projection[] is used without this field."},"children":[]}]}]}],"type":"object","properties":{"latitude":{"type":"number"},"longitude":{"type":"number"},"city":{"type":"string"},"region":{"description":"State, province, or administrative region","type":"string"},"country":{"description":"ISO country code","type":"string"},"zipcode":{"type":"string"}}},"heartbeat":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Most recent heartbeat received from the node's control plane connection. Omitted when projection[] is used without this field."},"children":[]}]}]}],"type":"object","properties":{"nodeId":{"type":"string"},"orgId":{"type":"string"},"gatekeeper":{"description":"ARN of the AWS ECS task handling this node's connection","type":"string"},"timestamp":{"description":"Unix timestamp of the heartbeat","type":"integer"},"source":{"type":"string"}}},"lifecycleState":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operational lifecycle state of the node. Omitted when projection[] is used without this field."},"children":[]}]}]}],"enum":["pre-production","production","maintenance","decommissioned"],"type":"string"},"disconnectTime":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unix timestamp (seconds) when the node last disconnected from the control plane. Omitted when projection[] is used without this field."},"children":[]}]}]}],"type":"integer"},"orderID":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UUID of the hardware provisioning order associated with this node. Omitted when projection[] is used without this field."},"children":[]}]}]}],"type":"string"}},"title":"Node","type":"object"}},"components/schemas/NodeConnectorsConfig":{"id":"components/schemas/NodeConnectorsConfig","kind":"json-schema","title":"NodeConnectorsConfig","data":{"description":"Edge connector (outbound tunnel endpoint) configuration","type":"object","properties":{"enabled":{"description":"Whether the connectors plugin is active on this node","type":"boolean"},"version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema version — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a UUID-keyed map; absent means "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connectors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a legacy ordered array"},"children":[]}]}]}],"type":"integer","enum":[2]},"items":{"description":"Connector definitions keyed by UUID (version 2 only)","type":"object","additionalProperties":{"$ref":"#/components/schemas/EdgeConnector"}},"connectors":{"description":"Connector definitions as an ordered array (legacy version 1 only)","type":"array","items":{"$ref":"#/components/schemas/EdgeConnector"}}}}},"components/schemas/NodeExecConfig":{"id":"components/schemas/NodeExecConfig","kind":"json-schema","title":"NodeExecConfig","data":{"description":"Edge compute (container runtime) configuration","type":"object","properties":{"commands":{"description":"Container definitions managed by this node","type":"array","items":{"$ref":"#/components/schemas/ContainerConfig"}},"volumes":{"description":"Named volumes available to containers on this node","type":"array","items":{"type":"object","properties":{"name":{"description":"Volume name (referenced by container mounts)","type":"string"},"encrypted":{"description":"Whether the volume is stored encrypted on disk","type":"boolean"},"location":{"description":"Optional filesystem path backing the volume","type":"string"}}}},"limits":{"description":"Global resource limits applied across all containers","type":"object","properties":{"cpuMax":{"description":"Maximum CPU utilization across all containers (percent of a single core, e.g. 200 for 2 cores)","type":"number"},"memMax":{"description":"Hard memory limit in bytes","type":"number"},"memHigh":{"description":"Soft memory limit in bytes (throttling threshold)","type":"number"},"ioRbps":{"description":"Maximum aggregate read throughput in bytes per second","type":"number"},"ioWbps":{"description":"Maximum aggregate write throughput in bytes per second","type":"number"},"ioRiops":{"description":"Maximum aggregate read IOPS","type":"number"},"ioWiops":{"description":"Maximum aggregate write IOPS","type":"number"}}}}}},"components/schemas/NodeNetworkConfig":{"id":"components/schemas/NodeNetworkConfig","kind":"json-schema","title":"NodeNetworkConfig","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Layer-3 network configuration — physical interfaces, tunnels, static routes, NAT rules, ACLs, traffic rules, and VRFs"},"children":[]}]}]}],"type":"object","properties":{"interfaces":{"description":"Physical and logical network interface configurations","type":"array","items":{"type":"object","properties":{"nic":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Physical or virtual NIC name (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eth0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"vrf":{"description":"VRF this interface belongs to","type":"string"},"virtual":{"description":"True when this is a virtual (bridge or bonded) interface rather than a physical NIC","type":"boolean"},"dhcp":{"description":"Whether the interface gets its address via DHCP","type":"boolean"},"ip":{"description":"Static IP address (with prefix length) when DHCP is disabled","type":"string"},"subnet":{"description":"Subnet mask or CIDR","type":"string"},"gateway":{"description":"Default gateway reachable through this interface","type":"string"},"dns":{"description":"DNS server addresses configured on this interface","type":"array","items":{"type":"string"}},"mtu":{"description":"Maximum transmission unit in bytes","type":"integer"},"duplex":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link duplex mode ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"full"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"half"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"auto"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"speed":{"description":"Link speed in Mbps","type":"number"},"mode":{"description":"Configuration mode","enum":["auto","manual"],"type":"string"},"description":{"type":"string"},"subInterfaces":{"description":"VLAN sub-interfaces attached to this NIC","type":"array","items":{"type":"object","properties":{"vlanID":{"type":"integer"},"vrf":{"type":"string"},"ip":{"type":"string"},"description":{"type":"string"}}}},"routes":{"description":"Per-interface static routes","type":"array","items":{"type":"object","properties":{"route":{"type":"string"},"next":{"type":"string"},"description":{"type":"string"}}}}}}},"tunnels":{"description":"IPsec, GRE, WireGuard, and VNet tunnel definitions","type":"array","items":{"type":"object","properties":{"type":{"description":"Tunnel type","enum":["ipsec","gre","vnet","wireguard"],"type":"string"},"name":{"description":"Tunnel name (unique on the node)","type":"string"},"enabled":{"type":"boolean"},"description":{"type":"string"},"ip":{"description":"Local tunnel endpoint IP","type":"string"},"vrf":{"description":"VRF the tunnel terminates in","type":"string"},"mtu":{"type":"integer"},"destination":{"description":"Remote tunnel endpoint (IPsec, GRE)","type":"string"},"networkId":{"description":"Virtual network ID (vnet tunnels) or IPsec SA ID","type":"integer"},"publicKey":{"description":"WireGuard peer public key (wireguard tunnels)","type":"string"},"presharedKey":{"description":"WireGuard preshared key (wireguard tunnels)","type":"string"},"ike":{"description":"IKE version (ipsec tunnels)","type":"integer"},"ikeCipher":{"description":"IKE cipher suite (ipsec tunnels)","type":"string"},"ikeGroup":{"description":"IKE Diffie-Hellman group (ipsec tunnels)","type":"integer"},"ipsecCipher":{"description":"ESP cipher suite (ipsec tunnels)","type":"string"},"psk":{"description":"Pre-shared key (ipsec tunnels)","type":"string"},"localId":{"type":"string"},"remoteId":{"type":"string"},"localSubnet":{"type":"string"},"remoteSubnet":{"type":"string"},"pfs":{"type":"integer"},"dpdInterval":{"type":"integer"},"dpdRetries":{"type":"integer"},"rekeyInterval":{"type":"integer"},"replayWindow":{"type":"integer"},"auto":{"enum":["add","start"],"type":"string"}}}},"routes":{"description":"Static routes installed on this node","type":"array","items":{"type":"object","properties":{"uid":{"type":"string"},"dest":{"description":"Destination CIDR","type":"string"},"via":{"description":"Next-hop gateway IP","type":"string"},"dev":{"description":"Egress interface or tunnel name","type":"string"},"metric":{"description":"Route metric (lower is preferred)","type":"number"},"description":{"type":"string"}}}},"nats":{"description":"NAT rules (SNAT, DNAT, masquerade)","type":"array","items":{"type":"object","properties":{"uid":{"type":"string"},"source":{"description":"Source CIDR the rule matches","type":"string"},"dest":{"description":"Destination CIDR the rule matches","type":"string"},"toSource":{"description":"Rewrite source to this address (SNAT)","type":"string"},"toDest":{"description":"Rewrite destination to this address (DNAT)","type":"string"},"masquerade":{"description":"When true, source is rewritten to the egress interface's address","type":"boolean"},"description":{"type":"string"}}}},"acls":{"description":"IP access control rules","type":"array","items":{"type":"object","properties":{"uid":{"type":"string"},"line":{"description":"Rule ordering; lower values evaluate first","type":"number"},"protocol":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Protocol ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tcp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"udp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"icmp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"source":{"description":"Source CIDR the rule matches","type":"string"},"dest":{"description":"Destination CIDR the rule matches","type":"string"},"ports":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination port or port range (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"443"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1000-2000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"action":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rule action ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"drop"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reject"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"description":{"type":"string"}}}},"rules":{"description":"Advanced traffic shaping and policy-based forwarding rules","type":"array","items":{"type":"object","properties":{"uid":{"type":"string"},"line":{"description":"Rule ordering; lower values evaluate first","type":"number"},"in":{"description":"Ingress interface the rule matches","type":"string"},"iface":{"description":"Egress interface override","type":"string"},"vrf":{"description":"VRF the rule applies within","type":"string"},"protocol":{"type":"string"},"source":{"type":"string"},"dest":{"type":"string"},"ports":{"type":"string"},"action":{"type":"string"},"snat":{"description":"When true, source-NAT matching traffic","type":"boolean"},"dnat":{"description":"When set, destination-NAT matching traffic to this address","type":"string"},"dmac":{"description":"When set, override destination MAC address for matching traffic","type":"string"},"description":{"type":"string"}}}},"vrfs":{"description":"VRF (Virtual Routing and Forwarding) instance definitions","type":"array","items":{"type":"object","properties":{"name":{"description":"VRF name","type":"string"},"description":{"type":"string"},"forwarding":{"description":"Whether IP forwarding is enabled within this VRF","type":"boolean"},"routes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Static routes scoped to this VRF (same shape as top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"routes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"nats":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NAT rules scoped to this VRF (same shape as top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nats"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"acls":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACLs scoped to this VRF (same shape as top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"acls"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}},"rules":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Traffic rules scoped to this VRF (same shape as top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"rules"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"array","items":{"type":"object","additionalProperties":true}}}}},"darkMode":{"description":"When true the node ignores unsolicited inbound traffic (stealth mode)","type":"boolean"},"forwarding":{"description":"Enable IP forwarding between interfaces","type":"boolean"},"bridgeCIDR":{"description":"CIDR assigned to the bridge interface used by container networking","type":"string"}}}},"components/schemas/NodeServicesConfig":{"id":"components/schemas/NodeServicesConfig","kind":"json-schema","title":"NodeServicesConfig","data":{"description":"Edge service (port-forwarding target) configuration","type":"object","properties":{"enabled":{"description":"Whether the services plugin is active on this node","type":"boolean"},"version":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schema version — "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" means "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a UUID-keyed map; absent means "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"services"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a legacy ordered array"},"children":[]}]}]}],"type":"integer","enum":[2]},"items":{"description":"Service definitions keyed by UUID (version 2 only)","type":"object","additionalProperties":{"$ref":"#/components/schemas/EdgeService"}},"services":{"description":"Service definitions as an ordered array (legacy version 1 only)","type":"array","items":{"$ref":"#/components/schemas/EdgeService"}}}}},"components/schemas/NodeVpnConfig":{"id":"components/schemas/NodeVpnConfig","kind":"json-schema","title":"NodeVpnConfig","data":{"description":"Virtual network (overlay) membership and routing configuration","type":"object","properties":{"networks":{"description":"Per-virtual-network configuration entries for this node","type":"array","items":{"type":"object","properties":{"id":{"description":"Virtual network numeric ID","type":"integer"},"name":{"description":"Virtual network name","type":"string"},"ip":{"description":"Node's IP address within this virtual network","type":"string"},"interfaces":{"description":"LAN-side interface bindings with inside/outside NAT rules","type":"array","items":{"type":"object","properties":{"name":{"description":"Local NIC or bridge bound into the virtual network","type":"string"},"inDefaultRoute":{"description":"When true, inbound traffic from the VPN uses this interface as its default route","type":"boolean"},"outDefaultRoute":{"description":"When true, outbound traffic to the VPN uses this interface as its default route","type":"boolean"},"insideNats":{"description":"NAT rules mapping local CIDRs to CIDRs on the VPN side (inbound)","type":"array","items":{"type":"object","properties":{"localCidr":{"type":"string"},"networkCidr":{"type":"string"},"description":{"type":"string"}}}},"outsideNats":{"description":"NAT rules mapping VPN CIDRs to local CIDRs (outbound)","type":"array","items":{"type":"object","properties":{"localCidr":{"type":"string"},"networkCidr":{"type":"string"},"networkGroup":{"type":"string"},"description":{"type":"string"}}}}}}},"routes":{"description":"Routes exported into or imported from this virtual network","type":"array","items":{"type":"object","properties":{"node":{"description":"Node FQDN advertising this route","type":"string"},"networkCidr":{"description":"CIDR being advertised","type":"string"},"metric":{"description":"Route metric (lower is preferred)","type":"number"},"path":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Route path type (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"primary"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"description":{"type":"string"}}}},"services":{"description":"Services exposed through this virtual network","type":"array","items":{"type":"object","properties":{"name":{"description":"Service name","type":"string"},"ip":{"description":"IP address the service is advertised on within the VPN","type":"string"},"port":{"description":"TCP port the service listens on","type":"number"}}}},"dns":{"description":"DNS settings for this virtual network membership","type":"object","properties":{"enabled":{"description":"Whether VPN-side DNS forwarding is enabled","type":"boolean"},"upstream":{"description":"Upstream DNS servers to forward VPN queries to","type":"array","items":{"type":"string"}}}}}}}}}},"components/schemas/NodeUpgrade":{"id":"components/schemas/NodeUpgrade","kind":"json-schema","title":"NodeUpgrade","data":{"description":"NodeUpgrade","properties":{"error":{"description":"Error message","type":"string"},"name":{"description":"Node name","example":"mynode","type":"string"},"nodeID":{"description":"Node ID","example":"19084f81-5668-41ee-adbe-295e4c65531a","type":"string"},"state":{"description":"Upgrade state","type":"string"},"tags":{"additionalProperties":{"description":"Tag values","type":"string"},"description":"Node tags","type":"object"}},"title":"NodeUpgrade","type":"object"}},"components/schemas/OpenIDConfig":{"id":"components/schemas/OpenIDConfig","kind":"json-schema","title":"OpenID Config","data":{"description":"OpenID Config","properties":{"authEndpoint":{"description":"Auth endpoint","example":"https://your-endpoint-url","type":"string"},"clientId":{"description":"Client ID","example":"some-client-id","type":"string"},"issuer":{"description":"Issuer","example":"https://your-issuer-url","type":"string"},"secret":{"description":"Client secret","example":"some-client-secret","type":"string"},"tokenEndpoint":{"description":"Token endpoint","example":"https://your-token-url","type":"string"},"userInfoEndpoint":{"description":"User info endpoint","example":"https://your-user-info-url","type":"string"}},"title":"OpenID Config","type":"object"}},"components/schemas/OrderAttachment":{"id":"components/schemas/OrderAttachment","kind":"json-schema","title":"Order Attachment","data":{"description":"File attached to an order","properties":{"key":{"description":"Storage key","type":"string"},"uid":{"description":"Attachment UID","type":"string"},"name":{"description":"Original filename","type":"string"},"owner":{"description":"User ID of the attachment uploader","type":"string"},"uploadedAt":{"description":"Timestamp when the attachment was uploaded","type":"string","format":"date-time"}},"title":"Order Attachment","type":"object"}},"components/schemas/OrderAudit":{"id":"components/schemas/OrderAudit","kind":"json-schema","title":"Order Audit","data":{"description":"Audit log entry for an order","properties":{"uid":{"description":"Audit entry UID","type":"string"},"userName":{"description":"User ID that performed the action","type":"string"},"createdAt":{"description":"Timestamp when the action occurred","type":"string","format":"date-time"},"auditType":{"description":"Type of audit event","type":"string"},"message":{"description":"Human-readable summary","type":"string"},"details":{"description":"Free-form details about the action","type":"string"},"changes":{"description":"Fields that changed in the action","items":{"$ref":"#/components/schemas/OrderAuditChange"},"type":"array"}},"title":"Order Audit","type":"object"}},"components/schemas/OrderAuditChange":{"id":"components/schemas/OrderAuditChange","kind":"json-schema","title":"Order Audit Change","data":{"description":"Single field change in an order audit entry","properties":{"field":{"description":"Field name","type":"string"},"oldValue":{"description":"Previous value","type":"string"},"newValue":{"description":"New value","type":"string"}},"title":"Order Audit Change","type":"object"}},"components/schemas/OrderComment":{"id":"components/schemas/OrderComment","kind":"json-schema","title":"Order Comment","data":{"description":"Comment on an order","properties":{"uid":{"description":"Comment UID","type":"string"},"body":{"description":"Comment text","type":"string"},"createdAt":{"description":"Timestamp when the comment was posted","type":"string","format":"date-time"},"user":{"description":"User ID of the commenter","type":"string"}},"title":"Order Comment","type":"object"}},"components/schemas/OrderHyperlink":{"id":"components/schemas/OrderHyperlink","kind":"json-schema","title":"Order Hyperlink","data":{"description":"External hyperlink associated with an order","properties":{"url":{"description":"URL","type":"string"},"description":{"description":"Display text","type":"string"}},"title":"Order Hyperlink","type":"object"}},"components/schemas/OrderPriority":{"id":"components/schemas/OrderPriority","kind":"json-schema","title":"Order Priority","data":{"description":"Order priority","enum":["normal","high","urgent"],"title":"Order Priority","type":"string"}},"components/schemas/OrderStatus":{"id":"components/schemas/OrderStatus","kind":"json-schema","title":"Order Status","data":{"description":"Order lifecycle status","enum":["new","on hold per client","gathering info","pending feedback","info received","provisioning","qa","shipped","delivered","installed","production ready","in production","archived","cancelled"],"title":"Order Status","type":"string"}},"components/schemas/OrderStakeholder":{"id":"components/schemas/OrderStakeholder","kind":"json-schema","title":"Order Stakeholder","data":{"description":"Stakeholder associated with an order","properties":{"name":{"description":"Name","type":"string"},"email":{"description":"Email address","type":"string"},"phone":{"description":"Phone number","type":"string"},"role":{"description":"Role or relationship to the order","type":"string"}},"title":"Order Stakeholder","type":"object"}},"components/schemas/OrderTransition":{"id":"components/schemas/OrderTransition","kind":"json-schema","title":"Order Transition","data":{"description":"Status transition recorded for an order","properties":{"from":{"$ref":"#/components/schemas/OrderStatus"},"to":{"$ref":"#/components/schemas/OrderStatus"},"timestamp":{"description":"Timestamp when the transition occurred","type":"string","format":"date-time"}},"title":"Order Transition","type":"object"}},"components/schemas/OrderValidation":{"id":"components/schemas/OrderValidation","kind":"json-schema","title":"Order Validation","data":{"description":"Validation result for an order","properties":{"valid":{"description":"Whether the order passes validation","type":"boolean"},"anonymous":{"description":"Top-level validation message","type":"string"},"nats":{"description":"NAT validation results","items":{"$ref":"#/components/schemas/OrderValidationNAT"},"type":"array"},"nodes":{"description":"Node validation results","items":{"$ref":"#/components/schemas/OrderValidationNode"},"type":"array"}},"title":"Order Validation","type":"object"}},"components/schemas/OrderValidationIface":{"id":"components/schemas/OrderValidationIface","kind":"json-schema","title":"Order Validation Interface","data":{"description":"Validation result for a single node interface","properties":{"valid":{"description":"Whether the interface passes validation","type":"boolean"},"ip":{"description":"IP address validation message","type":"string"},"subnet":{"description":"Subnet validation message","type":"string"},"gateway":{"description":"Gateway validation message","type":"string"},"anonymous":{"description":"General interface validation message","type":"string"}},"title":"Order Validation Interface","type":"object"}},"components/schemas/OrderValidationNAT":{"id":"components/schemas/OrderValidationNAT","kind":"json-schema","title":"Order Validation NAT","data":{"description":"Validation result for a single NAT entry","properties":{"valid":{"description":"Whether the NAT passes validation","type":"boolean"},"networkCidr":{"description":"Network CIDR validation message","type":"string"},"localCidr":{"description":"Local CIDR validation message","type":"string"}},"title":"Order Validation NAT","type":"object"}},"components/schemas/OrderValidationNode":{"id":"components/schemas/OrderValidationNode","kind":"json-schema","title":"Order Validation Node","data":{"description":"Validation result for a single node","properties":{"valid":{"description":"Whether the node passes validation","type":"boolean"},"name":{"description":"Node name validation message","type":"string"},"dns1":{"description":"DNS1 validation message","type":"string"},"dns2":{"description":"DNS2 validation message","type":"string"},"linkedNode":{"description":"Linked node validation message","type":"string"},"anonymous":{"description":"General node validation message","type":"string"},"interfaces":{"description":"Interface validation results","items":{"$ref":"#/components/schemas/OrderValidationIface"},"type":"array"}},"title":"Order Validation Node","type":"object"}},"components/schemas/OrderWebhookInput":{"id":"components/schemas/OrderWebhookInput","kind":"json-schema","title":"Order Webhook Input","data":{"description":"Flat webhook payload used to create an order","properties":{"contactName":{"type":"string"},"contactEmail":{"type":"string"},"companyName":{"type":"string"},"technicalContactName":{"type":"string"},"technicalContactEmail":{"type":"string"},"technicalContactPhone":{"type":"string"},"locationName":{"type":"string"},"siteType":{"type":"string"},"deploymentType":{"description":"Deployment type","enum":["High Availability Pair (HA)","Single Node"],"type":"string"},"interfacesCount":{"description":"Number of Ethernet interfaces","enum":["One Ethernet","Two Ethernet"],"type":"string"},"applianceType":{"type":"string"},"hypervisor":{"description":"Hypervisor or appliance type override","type":"string"},"rackMounts":{"description":"Whether rack mounts are requested","type":"string"},"firstNodeWANIP":{"type":"string"},"firstNodeWANSubnet":{"type":"string"},"firstNodeWANGw":{"type":"string"},"firstNodeLANIP":{"type":"string"},"firstNodeLANSubnet":{"type":"string"},"firstNodeLANGw":{"type":"string"},"secondNodeWANIP":{"type":"string"},"secondNodeWANSubnet":{"type":"string"},"secondNodeWANGw":{"type":"string"},"secondNodeLANIP":{"type":"string"},"secondNodeLANSubnet":{"type":"string"},"secondNodeLANGw":{"type":"string"},"dns1":{"type":"string"},"dns2":{"type":"string"},"clusterIp":{"type":"string"},"shippingCompanyName":{"type":"string"},"shippingContactEmail":{"type":"string"},"attn":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"notes":{"type":"string"},"NAT1Local":{"description":"NAT 1 local CIDR","type":"string"},"NAT1Desc":{"description":"NAT 1 description","type":"string"},"NAT2Local":{"description":"NAT 2 local CIDR","type":"string"},"NAT2Desc":{"description":"NAT 2 description","type":"string"},"NAT3Local":{"description":"NAT 3 local CIDR","type":"string"},"NAT3Desc":{"description":"NAT 3 description","type":"string"}},"title":"Order Webhook Input","type":"object"}},"components/schemas/OrderModel":{"id":"components/schemas/OrderModel","kind":"json-schema","title":"Order","data":{"description":"Hardware provisioning order","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"applianceType":{"type":"string"},"assignee":{"description":"Trustgrid user assigned to the order","type":"string"},"attachments":{"description":"Files attached to the order","items":{"$ref":"#/components/schemas/OrderAttachment"},"type":"array"},"attn":{"type":"string"},"carrierCode":{"description":"Shipping carrier code","type":"string"},"cellProvider":{"type":"string"},"city":{"type":"string"},"clonedFromId":{"description":"UID of the original order if this order is a clone","type":"string"},"clonedFromOrderNumber":{"description":"Order number of the original order if this order is a clone","type":"integer"},"clusterIp":{"type":"string"},"comments":{"description":"Comments on the order","items":{"$ref":"#/components/schemas/OrderComment"},"type":"array"},"companyName":{"type":"string"},"contactEmail":{"type":"string"},"contactName":{"type":"string"},"contactPhone":{"type":"string"},"createdAt":{"description":"Timestamp when the order was created","type":"string","format":"date-time"},"creator":{"description":"User ID of the order creator","type":"string"},"custom":{"description":"Custom key-value fields","type":"object","additionalProperties":{"type":"string"}},"customerRefNum":{"type":"string"},"dataPlan":{"type":"string"},"dns1":{"description":"Legacy primary DNS","type":"string"},"dns2":{"description":"Legacy secondary DNS","type":"string"},"dueDate":{"type":"string"},"endUserAccountNum":{"type":"string"},"failoverType":{"type":"string"},"flagged":{"type":"boolean"},"ha":{"description":"True when this order is for an HA pair","type":"boolean"},"hyperlinks":{"description":"Customer-facing hyperlinks","items":{"$ref":"#/components/schemas/OrderHyperlink"},"type":"array"},"interfacesCount":{"description":"Number of interfaces to configure per node","maximum":2,"minimum":1,"type":"number"},"labels":{"description":"Labels attached to the order","items":{"type":"string"},"type":"array"},"locationName":{"type":"string"},"nats":{"items":{"properties":{"description":{"description":"Description","type":"string"},"localCidr":{"description":"Local CIDR","type":"string"},"networkCidr":{"description":"Network CIDR","type":"string"}},"type":"object"},"type":"array"},"noBill":{"description":"Whether the order should not be billed","type":"boolean"},"nodeCount":{"description":"Number of nodes needed to fulfill order","maximum":2,"minimum":1,"type":"number"},"nodes":{"items":{"properties":{"dns1":{"type":"string"},"dns2":{"type":"string"},"interfaces":{"items":{"properties":{"dhcp":{"type":"boolean"},"gateway":{"type":"string"},"ip":{"type":"string"},"subnet":{"type":"string"}},"type":"object"},"type":"array"},"linkedNode":{"description":"UID of the linked provisioned node","type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"},"notes":{"type":"string"},"orderNum":{"description":"System-wide unique order number","type":"number"},"orgId":{"description":"Organization ID","type":"string"},"orgName":{"description":"Organization display name","type":"string"},"priority":{"$ref":"#/components/schemas/OrderPriority"},"projectID":{"description":"Associated project ID","type":"string"},"rackMounts":{"description":"Whether rack mounts are requested","type":"boolean"},"rma":{"description":"Whether this order is an RMA","type":"boolean"},"shippedDate":{"description":"Timestamp when the order shipped","type":"string","format":"date-time"},"shippingCompanyName":{"type":"string"},"shippingContactEmail":{"type":"string"},"shippingStatus":{"description":"Carrier shipping status","type":"string"},"shipStationOrderId":{"description":"ShipStation order ID","type":"integer"},"siteName":{"type":"string"},"siteType":{"description":"Site deployment type","enum":["primary","secondary","test"],"type":"string"},"stakeholders":{"description":"Order stakeholders","items":{"$ref":"#/components/schemas/OrderStakeholder"},"type":"array"},"state":{"type":"string"},"status":{"description":"Order status. API-side holistic validations apply to orders whose\nstatus is in provisioning, qa, shipped, delivered, installed, and in\nproduction.","allOf":[{"$ref":"#/components/schemas/OrderStatus"}]},"summary":{"type":"string"},"technicalContactEmail":{"type":"string"},"technicalContactName":{"type":"string"},"technicalContactPhone":{"type":"string"},"tgHyperlinks":{"description":"Trustgrid-facing hyperlinks","items":{"$ref":"#/components/schemas/OrderHyperlink"},"type":"array"},"tgNotes":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Trustgrid-internal notes (visible only to users with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"trustgrid::order-notes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"type":"string"},"trackingNumber":{"description":"Carrier tracking number","type":"string"},"transitions":{"description":"Status transition history","items":{"$ref":"#/components/schemas/OrderTransition"},"type":"array"},"uid":{"type":"string"},"validations":{"description":"Live validation results for the order","allOf":[{"$ref":"#/components/schemas/OrderValidation"}]},"zip":{"type":"string"}},"title":"Order","type":"object"}},"components/schemas/OrgModel":{"id":"components/schemas/OrgModel","kind":"json-schema","title":"OrgModel","data":{"properties":{"uid":{"description":"Organization ID (UUID)","type":"string"},"name":{"description":"Organization display name","type":"string"},"domain":{"description":"Root domain for this organization (e.g. \"myorg.trustgrid.io\")","type":"string"},"idp_provider":{"description":"Identity provider used for authentication (e.g. \"trustgrid\" for built-in)","type":"string"},"aws_account_id":{"description":"AWS account ID associated with the organization","type":"string"},"supportable":{"description":"Whether Trustgrid support can access this org","type":"boolean"},"allowed_ips":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"IP allowlist for portal access (empty = unrestricted)"},"children":[]}]}]}],"type":"array","items":{"type":"string"}},"emergencyDestination":{"description":"Emergency contact email","type":"string"},"licenses":{"description":"License counts for node types","type":"object","properties":{"appliances":{"type":"integer"},"agents":{"type":"integer"}}},"technicalContact":{"description":"Technical contact for the organization","type":"object","properties":{"name":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}}},"billingContact":{"description":"Billing contact for the organization","type":"object","properties":{"name":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}}},"businessContact":{"description":"Business contact for the organization","type":"object","properties":{"name":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"email":{"type":"string","nullable":true}}},"s3_bucket":{"description":"S3 bucket for log exports (if configured)","type":"string"},"s3_access_key":{"description":"S3 access key for log exports (if configured)","type":"string"},"s3_prefix":{"description":"S3 key prefix for log exports (if configured)","type":"string"},"s3_region":{"description":"S3 region for log exports (if configured)","type":"string"}},"required":["name"],"title":"OrgModel","type":"object"}},"components/schemas/PolicyExpression":{"id":"components/schemas/PolicyExpression","kind":"json-schema","title":"PolicyExpression","data":{"description":"Policy expression","type":"object","example":{"eq":{"tg:node:tags:environment":["production"],"tg:node:tags:another-tag":["always-match"]},"ne":{"tg:node:tags:environment":["staging"],"tg:node:tags:another-tag":["dont-match"]}},"properties":{"ne":{"type":"object","additionalProperties":{"description":"Conditions to not match","type":"array","items":{"type":"string"}}},"eq":{"type":"object","additionalProperties":{"description":"Conditions to match","type":"array","items":{"type":"string"}}}}}},"components/schemas/Policy":{"id":"components/schemas/Policy","kind":"json-schema","title":"Policy","data":{"description":"Policy","properties":{"description":{"description":"Policy description","example":"My policy description","type":"string"},"name":{"description":"Policy name","example":"my-policy","type":"string"},"resources":{"items":{"description":"TGRNs affected by the policy","type":"string"},"type":"array"},"conditions":{"type":"object","properties":{"all":{"$ref":"#/components/schemas/PolicyExpression"},"any":{"$ref":"#/components/schemas/PolicyExpression"},"none":{"$ref":"#/components/schemas/PolicyExpression"}}},"statements":{"items":{"description":"Permission statement","properties":{"actions":{"items":{"description":"action","type":"string"},"type":"array"},"effect":{"description":"Statement effect","enum":["allow","deny","noop"],"type":"string"}},"type":"object"},"type":"array"}},"title":"Policy","type":"object"}},"components/schemas/PortForwarding":{"id":"components/schemas/PortForwarding","kind":"json-schema","title":"Port Forwarding","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Port Forwarding rule — maps a virtual network service to a node IP and port"},"children":[]}]}]}],"properties":{"uid":{"description":"Unique identifier (UUID)","type":"string"},"serviceName":{"description":"Name of the service being forwarded","type":"string"},"nodeName":{"description":"Name of the node receiving forwarded traffic","type":"string"},"ip":{"description":"Node IP address traffic is forwarded to","type":"string"},"port":{"description":"Port number traffic is forwarded to","type":"integer"},"networkName":{"description":"Virtual network this rule belongs to","type":"string"},"domainName":{"description":"Domain this rule belongs to","type":"string"},"orgId":{"description":"Organization ID","type":"string"},"type":{"description":"Object type discriminator","example":"PortForward","type":"string"}},"title":"Port Forwarding","type":"object"}},"components/schemas/RepositoryModel":{"id":"components/schemas/RepositoryModel","kind":"json-schema","title":"RepositoryModel","data":{"properties":{"name":{"type":"string"}},"title":"RepositoryModel","type":"object"}},"components/schemas/RepositoryTagModel":{"id":"components/schemas/RepositoryTagModel","kind":"json-schema","title":"RepositoryTagModel","data":{"properties":{"name":{"type":"string"}},"title":"RepositoryTagModel","type":"object"}},"components/schemas/SAMLConfig":{"id":"components/schemas/SAMLConfig","kind":"json-schema","title":"SAML Config","data":{"description":"SAML Config","properties":{"cert":{"description":"Certificate","example":"your-idp-cert","type":"string"},"issuer":{"description":"Issuer","example":"https://your-issuer-url","type":"string"},"loginUrl":{"description":"Login URL","example":"https://idp-login-url","type":"string"},"token_expiration":{"description":"Token expiration","example":3600,"type":"number"}},"title":"SAML Config","type":"object"}},"components/schemas/EdgeService":{"id":"components/schemas/EdgeService","kind":"json-schema","title":"EdgeService","data":{"example":{"name":"gw-http","protocol":"tcp","port":5000,"host":"192.168.200.62","enabled":true,"sourceInterface":"ens192","sourceFromClusterIP":true},"properties":{"description":{"description":"service description","type":"string"},"enabled":{"description":"whether service is enabled","type":"boolean"},"host":{"description":"destination host name","type":"string"},"index":{"description":"sorting index","type":"number"},"name":{"description":"service name","type":"string"},"port":{"description":"destination port","maximum":65536,"minimum":1,"type":"number"},"protocol":{"description":"protocol","enum":["udp","tcp","tftp","ftp","rdp","vnc","ssh"],"type":"string"},"sourceFromClusterIP":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When true and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceInterface"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set, the forwarder binds the outbound"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"socket to the cluster VIP on that interface instead of the active node's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"interface IP. Has no effect unless "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceInterface"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also set. Only"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"meaningful on cluster services; ignored on standalone node services."},"children":[]}]}]}],"type":"boolean"},"sourceInterface":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NIC name (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ens192"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") the L4 forwarder uses to source the upstream connection. Valid on its own to control source interface binding; also required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceFromClusterIP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to take effect."},"children":[]}]}]}],"type":"string"}},"required":["host","port","protocol","name"],"type":"object"}},"components/schemas/ServiceConfig":{"id":"components/schemas/ServiceConfig","kind":"json-schema","title":"ServiceConfig","data":{"example":{"services":[{"description":"nginx","enabled":true,"host":"127.0.0.1","id":"1e1d36b2-63b6-46bb-8334-a80a828afb5f","name":"nginx","port":80,"protocol":"tcp"}]},"properties":{"services":{"items":{"properties":{"description":{"description":"service description","type":"string"},"enabled":{"description":"whether service is enabled","type":"boolean"},"host":{"description":"destination host name","type":"string"},"id":{"description":"unique ID of service","type":"string"},"name":{"description":"service name","type":"string"},"port":{"description":"destination port","maximum":65536,"minimum":1,"type":"number"},"protocol":{"description":"protocol","enum":["udp","tcp","tftp","ftp","rdp","vnc","ssh"],"type":"string"}},"required":["id","host","port","protocol","name"],"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/Tag":{"id":"components/schemas/Tag","kind":"json-schema","title":"Tag","data":{"description":"Tag","properties":{"created_at":{"description":"Unix timestamp when tag was created","type":"number"},"name":{"description":"Tag name","example":"prod_status","type":"string"},"values":{"items":{"description":"Tag values","type":"string"},"type":"array"}},"title":"Tag","type":"object"}},"components/schemas/TagValueModel":{"id":"components/schemas/TagValueModel","kind":"json-schema","title":"TagValueModel","data":{"properties":{"value":{"description":"Tag value","type":"string"}},"required":["value"],"title":"TagValueModel","type":"object"}},"components/schemas/Upgrade":{"id":"components/schemas/Upgrade","kind":"json-schema","title":"Upgrade","data":{"description":"Upgrade","properties":{"clusterUpgrades":{"items":{"$ref":"#/components/schemas/ClusterUpgrade"},"type":"array"},"completedAt":{"description":"Upgrade completion time","type":"string"},"dryRun":{"description":"Whether this was a dry-run","type":"boolean"},"excludeTags":{"additionalProperties":{"description":"Tag values","type":"string"},"description":"Exclude devices with these tags","type":"object"},"failoverApproved":{"description":"True once a user has approved cluster failovers","type":"boolean"},"includeTags":{"additionalProperties":{"description":"Tag values","type":"string"},"description":"Include devices with these tags","type":"object"},"manualFailover":{"description":"Whether to require approval to failover clusters","type":"boolean"},"name":{"description":"Name of upgrade","example":"Sep27","type":"string"},"nodeUpgrades":{"items":{"$ref":"#/components/schemas/NodeUpgrade"},"type":"array"},"offlineTimeout":{"description":"Minutes to wait before failing (timing out) a workflow for a node in the offline state","type":"number"},"startedAt":{"description":"Upgrade start time","type":"string"},"status":{"description":"Status of upgrade","enum":["active","planning","complete"],"type":"string"},"uid":{"description":"Unique ID of upgrade","example":"2DqxLdknjWxEkGt474d2Cstsa1O","type":"string"},"upgradeTimeout":{"description":"Minutes to wait before failing (timing out) a workflow","type":"number"}},"title":"Upgrade","type":"object"}},"components/schemas/UpgradeLog":{"id":"components/schemas/UpgradeLog","kind":"json-schema","title":"UpgradeLog","data":{"description":"UpgradeLog","properties":{"entity":{"description":"Log subject type","example":"Node","type":"string"},"entityID":{"description":"Log subject ID","example":"19084f81-5668-41ee-adbe-295e4c65531a","type":"string"},"level":{"description":"Level of log, like error/warn/info","type":"string"},"message":{"description":"Log message","type":"string"},"timestamp":{"description":"Timestamp of log entry","example":"2024-10-21 11:55:26.066709233 -0600 MDT m=+0.000520863","type":"string"},"uid":{"description":"Unique ID of log entry","example":"821abe7a-f895-4fa7-93d6-e03d4f82153c","type":"string"}},"title":"UpgradeLog","type":"object"}},"components/schemas/UpgradeUpdateParams":{"id":"components/schemas/UpgradeUpdateParams","kind":"json-schema","title":"UpgradeUpdateParams","data":{"description":"UpgradeUpdateParams","properties":{"excludeTags":{"additionalProperties":{"description":"Tag values","type":"string"},"description":"Exclude devices with these tags","type":"object"},"includeTags":{"additionalProperties":{"description":"Tag values","type":"string"},"description":"Include devices with these tags","type":"object"},"manualFailover":{"description":"Whether to require approval to failover clusters","type":"boolean"},"name":{"description":"Upgrade name","type":"string"},"offlineTimeout":{"description":"Minutes to wait before failing (timing out) a workflow for a node in the offline state","type":"number"},"upgradeTimeout":{"description":"Minutes to wait before failing (timing out) a workflow","type":"number"}},"required":["name"],"title":"UpgradeUpdateParams","type":"object"}},"components/schemas/UserModel":{"id":"components/schemas/UserModel","kind":"json-schema","title":"UserModel","data":{"properties":{"email":{"description":"User's email address (also used as login)","type":"string"},"status":{"description":"Whether the user account is active","enum":["active","inactive"],"type":"string"},"policyIds":{"description":"IDs of named policies assigned to this user","items":{"type":"string"},"type":"array"},"policy":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Inline permission policy map. Keys are resource types (e.g. \"virtual-networks\"), values are scope → action → boolean maps. Present when the user has inline permissions in addition to named policies."},"children":[]}]}]}],"type":"object","additionalProperties":{}},"permissions":{"description":"Resolved effective permissions (may be empty object if using policyIds)","type":"object","additionalProperties":{}},"landingPage":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom landing page path after login (null = default)"},"children":[]}]}]}],"type":"string","nullable":true}},"title":"UserModel","type":"object"}},"components/schemas/ValidationFailed":{"id":"components/schemas/ValidationFailed","kind":"json-schema","title":"ValidationFailed","data":{"description":"ValidationFailed","items":{"description":"Validation failure","type":"string"},"title":"ValidationFailed","type":"array"}},"components/schemas/VirtualNetwork":{"id":"components/schemas/VirtualNetwork","kind":"json-schema","title":"Virtual Network","data":{"description":"Virtual Network","properties":{"id":{"description":"Internal numeric ID","type":"integer"},"name":{"description":"Name of virtual network","type":"string"},"description":{"type":"string"},"networkCidr":{"description":"Virtual network CIDR","example":"10.10.14.0/24","type":"string"},"orgId":{"description":"Organization ID","type":"string"},"uid":{"description":"Unique identifier (UUID)","type":"string"},"domainName":{"description":"Domain this network belongs to","type":"string"},"noNat":{"description":"Whether NAT is disabled for this network","type":"boolean"},"type":{"description":"Object type discriminator","example":"DomainNetwork","type":"string"}},"title":"Virtual Network","type":"object"}},"components/schemas/Volume":{"id":"components/schemas/Volume","kind":"json-schema","title":"Volume","data":{"description":"Volume","properties":{"encrypted":{"description":"Encrypted","type":"boolean"},"name":{"description":"Volume name","example":"myvolume","type":"string"}},"title":"Volume","type":"object"}},"components/schemas/VpnClusterDnsModel":{"id":"components/schemas/VpnClusterDnsModel","kind":"json-schema","title":"VpnClusterDnsModel","data":{"allOf":[{"$ref":"#/components/schemas/VpnDnsUpdateModel"},{"properties":{"fqdn":{"type":"string"},"networkName":{"type":"string"}},"type":"object"}]}},"components/schemas/VpnClusterInterfaceModel":{"id":"components/schemas/VpnClusterInterfaceModel","kind":"json-schema","title":"VpnClusterInterfaceModel","data":{"allOf":[{"$ref":"#/components/schemas/VpnInterfaceUpdateModel"},{"properties":{"fqdn":{"type":"string"},"networkName":{"type":"string"}},"type":"object"}]}},"components/schemas/VpnClusterNetworkInventoryModel":{"id":"components/schemas/VpnClusterNetworkInventoryModel","kind":"json-schema","title":"VpnClusterNetworkInventoryModel","data":{"properties":{"dns":{"$ref":"#/components/schemas/VpnClusterDnsModel"},"exportRoutes":{"items":{"$ref":"#/components/schemas/VpnNodeRouteModel"},"type":"array"},"importRoutes":{"items":{"$ref":"#/components/schemas/VpnNodeRouteModel"},"type":"array"},"interfaces":{"items":{"$ref":"#/components/schemas/VpnClusterInterfaceModel"},"type":"array"},"route":{"type":"string"},"routes":{"items":{"$ref":"#/components/schemas/VpnClusterRouteModel"},"type":"array"},"services":{"items":{"$ref":"#/components/schemas/VpnClusterServiceModel"},"type":"array"}},"type":"object"}},"components/schemas/VpnClusterNetworkModel":{"id":"components/schemas/VpnClusterNetworkModel","kind":"json-schema","title":"VpnClusterNetworkModel","data":{"allOf":[{"$ref":"#/components/schemas/VpnNetworkUpdateModel"},{"properties":{"fqdn":{"type":"string"},"networkName":{"type":"string"}},"type":"object"}]}},"components/schemas/VpnClusterRouteModel":{"id":"components/schemas/VpnClusterRouteModel","kind":"json-schema","title":"VpnClusterRouteModel","data":{"allOf":[{"$ref":"#/components/schemas/VpnRouteUpdateModel"},{"properties":{"fqdn":{"type":"string"},"networkName":{"type":"string"},"uid":{"type":"string"}},"type":"object"}]}},"components/schemas/VpnClusterServiceModel":{"id":"components/schemas/VpnClusterServiceModel","kind":"json-schema","title":"VpnClusterServiceModel","data":{"allOf":[{"$ref":"#/components/schemas/VpnServiceUpdateModel"},{"properties":{"fqdn":{"type":"string"},"networkName":{"type":"string"},"uid":{"type":"string"}},"type":"object"}]}},"components/schemas/VpnDnsUpdateModel":{"id":"components/schemas/VpnDnsUpdateModel","kind":"json-schema","title":"VpnDnsUpdateModel","data":{"properties":{"enabled":{"description":"Whether DNS forwarding is enabled on this VPN network","type":"boolean"},"upstream":{"description":"Upstream DNS servers to forward queries to","items":{"type":"object","properties":{"ip":{"description":"IP address of the upstream DNS server","type":"string"},"port":{"description":"Port of the upstream DNS server (default 53)","type":"integer"},"description":{"description":"Human-readable label for this upstream server","type":"string"}}},"type":"array"}},"type":"object"}},"components/schemas/VpnInterfaceUpdateModel":{"id":"components/schemas/VpnInterfaceUpdateModel","kind":"json-schema","title":"VpnInterfaceUpdateModel","data":{"properties":{"inDefaultRoute":{"type":"boolean"},"insideNats":{"items":{"properties":{"description":{"type":"string"},"localCidr":{"type":"string"},"networkCidr":{"type":"string"}},"type":"object"},"type":"array"},"interfaceName":{"type":"string"},"outDefaultRoute":{"type":"boolean"},"outsideNats":{"description":"NAT rules for traffic leaving the VPN network (outbound). Maps VPN-side CIDRs to local node CIDRs.","items":{"properties":{"description":{"type":"string"},"localCidr":{"description":"Local node CIDR to map to","type":"string"},"networkCidr":{"description":"VPN-side CIDR to translate","type":"string"},"networkGroup":{"type":"string"},"proxyArp":{"description":"When true, the node responds to ARP requests for the networkCidr on behalf of local hosts","type":"boolean"}},"type":"object"},"type":"array"}},"type":"object"}},"components/schemas/VpnNetworkUpdateModel":{"id":"components/schemas/VpnNetworkUpdateModel","kind":"json-schema","title":"VpnNetworkUpdateModel","data":{"properties":{"ip":{"type":"string"},"name":{"type":"string"},"route":{"type":"string"}},"type":"object"}},"components/schemas/VpnNodeDnsModel":{"id":"components/schemas/VpnNodeDnsModel","kind":"json-schema","title":"VpnNodeDnsModel","data":{"allOf":[{"$ref":"#/components/schemas/VpnDnsUpdateModel"},{"properties":{"networkName":{"type":"string"},"nodeUid":{"type":"string"}},"type":"object"}]}},"components/schemas/VpnNodeInterfaceModel":{"id":"components/schemas/VpnNodeInterfaceModel","kind":"json-schema","title":"VpnNodeInterfaceModel","data":{"allOf":[{"$ref":"#/components/schemas/VpnInterfaceUpdateModel"},{"properties":{"networkName":{"type":"string"},"nodeUid":{"type":"string"}},"type":"object"}]}},"components/schemas/VpnNodeNetworkInventoryModel":{"id":"components/schemas/VpnNodeNetworkInventoryModel","kind":"json-schema","title":"VpnNodeNetworkInventoryModel","data":{"description":"Full details of a VPN network attached to a node, including all routes, services, interfaces, DNS, and WireGuard configuration.","properties":{"networkName":{"description":"Name of the VPN network","type":"string"},"ip":{"description":"IP address assigned to this node within the VPN network","example":"172.16.101.201","type":"string"},"route":{"description":"CIDR of the VPN network's address space","example":"172.16.101.0/24","type":"string"},"dns":{"$ref":"#/components/schemas/VpnNodeDnsModel"},"exportRoutes":{"description":"Dynamic export routes advertised by this node into the VPN","items":{"$ref":"#/components/schemas/VpnNodeRouteModel"},"type":"array"},"importRoutes":{"description":"Dynamic import routes received by this node from the VPN","items":{"$ref":"#/components/schemas/VpnNodeRouteModel"},"type":"array"},"interfaces":{"description":"Physical or virtual interfaces bound to this VPN network with NAT rules","items":{"$ref":"#/components/schemas/VpnNodeInterfaceModel"},"type":"array"},"routes":{"description":"Static routes published by this node into the VPN network","items":{"$ref":"#/components/schemas/VpnNodeRouteModel"},"type":"array"},"services":{"description":"L4 services exposed by this node on the VPN network","items":{"$ref":"#/components/schemas/VpnNodeServiceModel"},"type":"array"},"wireguard":{"description":"WireGuard tunnel configuration for this VPN network attachment","type":"object","properties":{"enabled":{"description":"Whether WireGuard tunneling is enabled","type":"boolean"},"port":{"description":"WireGuard listen port on this node","type":"integer"},"forwarding":{"description":"Whether IP forwarding is enabled for WireGuard traffic","type":"boolean"},"clients":{"description":"List of authorized WireGuard peer clients","type":"array","items":{"type":"object","properties":{"name":{"description":"Human-readable client name","type":"string"},"publicKey":{"description":"WireGuard peer public key","type":"string"},"presharedKey":{"description":"Optional pre-shared key for the WireGuard tunnel","type":"string"},"defaultRouting":{"description":"When true, the client uses this VPN as its default route","type":"boolean"},"insideNats":{"description":"NAT rules mapping local CIDRs to client-side CIDRs (inbound)","type":"array","items":{"type":"object","properties":{"localCidr":{"type":"string"},"networkCidr":{"type":"string"},"description":{"type":"string"}}}},"outsideNats":{"description":"NAT rules mapping client-side CIDRs to local CIDRs (outbound)","type":"array","items":{"type":"object","properties":{"localCidr":{"type":"string"},"networkCidr":{"type":"string"},"networkGroup":{"type":"string"},"description":{"type":"string"}}}}}}}}}},"type":"object"}},"components/schemas/VpnNodeNetworkModel":{"id":"components/schemas/VpnNodeNetworkModel","kind":"json-schema","title":"VpnNodeNetworkModel","data":{"description":"Summary of a VPN network attached to a node, as returned by the list endpoint","allOf":[{"$ref":"#/components/schemas/VpnNetworkUpdateModel"},{"properties":{"id":{"description":"Numeric identifier for this node-network attachment","type":"integer"},"networkName":{"description":"Name of the VPN network","type":"string"},"nodeUid":{"description":"UUID of the node this network is attached to","type":"string"}},"type":"object"}]}},"components/schemas/VpnNodeRouteModel":{"id":"components/schemas/VpnNodeRouteModel","kind":"json-schema","title":"VpnNodeRouteModel","data":{"allOf":[{"$ref":"#/components/schemas/VpnRouteUpdateModel"},{"properties":{"networkName":{"description":"Name of the VPN network this route belongs to","type":"string"},"nodeUid":{"description":"UUID of the node that owns this route","type":"string"},"uid":{"description":"Unique identifier for this route","type":"string"},"nodeFriendlyName":{"description":"Human-readable name of the node that owns this route","type":"string"},"type":{"description":"Record type discriminator, always \"Route\"","type":"string","enum":["Route"]}},"type":"object"}]}},"components/schemas/VpnNodeServiceModel":{"id":"components/schemas/VpnNodeServiceModel","kind":"json-schema","title":"VpnNodeServiceModel","data":{"allOf":[{"$ref":"#/components/schemas/VpnServiceUpdateModel"},{"properties":{"networkName":{"description":"Name of the VPN network this service belongs to","type":"string"},"nodeUid":{"description":"UUID of the node that owns this service","type":"string"},"uid":{"description":"Unique identifier for this service","type":"string"},"type":{"description":"Record type discriminator, always \"Service\"","type":"string","enum":["Service"]}},"type":"object"}]}},"components/schemas/VpnRouteUpdateModel":{"id":"components/schemas/VpnRouteUpdateModel","kind":"json-schema","title":"VpnRouteUpdateModel","data":{"properties":{"description":{"type":"string"},"metric":{"type":"number"},"networkCidr":{"type":"string"},"node":{"type":"string"},"path":{"type":"string"},"monitors":{"items":{"$ref":"#/components/schemas/VirtualNetworkRouteMonitor"},"type":"array"}},"type":"object"}},"components/schemas/VpnServiceUpdateModel":{"id":"components/schemas/VpnServiceUpdateModel","kind":"json-schema","title":"VpnServiceUpdateModel","data":{"properties":{"ip":{"type":"string"},"name":{"type":"string"},"port":{"type":"number"}},"type":"object"}},"components/schemas/ServiceUser":{"id":"components/schemas/ServiceUser","kind":"json-schema","title":"ServiceUser","data":{"type":"object","properties":{"name":{"description":"Service account name (used as identifier)","type":"string"},"status":{"description":"Whether the service account is active","type":"string","enum":["active","inactive"]},"clientId":{"description":"Client ID used for API authentication (present after token generation)","type":"string"},"policyIds":{"description":"Named policy IDs attached to this service account","example":["builtin-tg-monitor"],"type":"array","items":{"type":"string"}},"tokenCreated":{"description":"Unix epoch timestamp (seconds) when the API token was last generated","type":"integer"},"orgId":{"description":"Organization ID","type":"string"}}}},"components/schemas/ObservabilityExporter":{"id":"components/schemas/ObservabilityExporter","kind":"json-schema","title":"ObservabilityExporter","data":{"properties":{"uid":{"type":"string"},"name":{"type":"string"},"enabled":{"type":"boolean"},"exporterType":{"type":"string","enum":["splunk","http"]},"collectionTypes":{"items":{"type":"string","enum":["metrics","node_audits","node_events","changes"]},"type":"array"},"description":{"type":"string"}},"required":["name","enabled","exporterType"],"title":"ObservabilityExporter","type":"object"}},"components/schemas/SplunkExporter":{"id":"components/schemas/SplunkExporter","kind":"json-schema","title":"SplunkExporter","data":{"properties":{"uid":{"type":"string"},"token":{"type":"string"},"endpoint":{"type":"string"},"source":{"type":"string"},"sourcetype":{"type":"string"},"index":{"type":"string"},"cacert":{"type":"string"},"enableLogData":{"type":"boolean"},"insecureTLS":{"type":"boolean"}},"required":["token","endpoint"],"title":"SplunkExporter","type":"object"}},"components/schemas/HTTPExporter":{"id":"components/schemas/HTTPExporter","kind":"json-schema","title":"HTTPExporter","data":{"properties":{"uid":{"type":"string"},"endpoint":{"type":"string"},"metricsEndpoint":{"type":"string"},"logsEndpoint":{"type":"string"},"encoding":{"type":"string","enum":["json","proto"]},"compression":{"type":"string","enum":["gzip","zstd","zlib","none"]},"timeout":{"type":"number"},"readBufferSize":{"type":"number"},"writeBufferSize":{"type":"number"},"cacert":{"type":"string"},"insecureTLS":{"type":"boolean"}},"title":"HTTPExporter","type":"object"}},"schema_238":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AlarmModel"},"type":"array"},"id":"schema_238"},"schema_239":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AlarmChannelModel"},"type":"array"},"id":"schema_239"},"schema_240":{"kind":"json-schema","data":{"type":"string"},"id":"schema_240"},"schema_241":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Alert"},"type":"array"},"id":"schema_241"},"schema_242":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/AlertV2"},"type":"array"},"id":"schema_242"},"schema_243":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_243"},"schema_244":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["INFO","WARNING","ERROR","CRITICAL"]}},"id":"schema_244"},"schema_245":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["Node","Certificate","Order","Upgrade","AlertSuppression"]}},"id":"schema_245"},"schema_246":{"kind":"json-schema","data":{"type":"number"},"id":"schema_246"},"schema_247":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/EventModel"}},"id":"schema_247"},"schema_248":{"kind":"json-schema","data":{"type":"object","properties":{"x-total-count":{"type":"number","description":"Total number of filtered events"}}},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"type":"object","properties":{"x-total-count":{"type":"number","description":"Total number of filtered node events"}}},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"description":"Domain","properties":{"config":{"description":"Domain-level configuration. Includes firewall policy snapshots derived from virtual network access policies, API gateway routing, and hosted gateway settings.","type":"object","properties":{"updateTime":{"description":"Unix timestamp of the last configuration update","type":"integer"},"gateway":{"description":"Hosted gateway settings for the domain","type":"object","properties":{"hosted":{"description":"Whether the domain uses a Trustgrid-managed hosted gateway","type":"boolean"}}},"apigw":{"description":"API gateway routing configuration for the domain","type":"object","properties":{"host":{"description":"API gateway hostname","type":"string"},"port":{"description":"API gateway port","type":"string"},"gateway_node":{"description":"FQDN of the node acting as the primary API gateway","type":"string"},"application_gateway_node":{"description":"FQDN of the application gateway node (if separate from the primary)","type":"string"}}},"firewall":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compiled firewall policy snapshot derived from virtual network access policies. Read-only; updated automatically when network policies change. Shape mirrors the internal iptables-style rule set and is not part of the public API contract — treat as opaque."},"children":[]}]}]}],"type":"object","additionalProperties":true}}}},"type":"object"},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"description":"Domain-level alert threshold configuration","type":"object","properties":{"enabled":{"description":"Whether alert threshold evaluation is active for this domain","type":"boolean"},"thresholds":{"description":"Alert rules evaluated against node telemetry values within the domain","type":"array","items":{"type":"object","properties":{"id":{"description":"Rule ID (UUID)","type":"string"},"name":{"description":"Human-readable rule name","type":"string"},"telemetry":{"description":"Telemetry metric to evaluate","enum":["cpu","ram","disk","heap","embflows","latency","bandwidthIn","bandwidthOut","tcpResets","vpnFlows"],"type":"string"},"max":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upper bound — alert fires when the value exceeds this"},"children":[]}]}]}],"type":"number"},"exceededWindow":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of time units the value must continuously exceed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]}]}]}],"type":"number"},"exceededWindowUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time unit for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exceededWindow"},"children":[]}]}]}],"enum":["minutes","hours"],"type":"string"}}}}}},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"description":"Domain-level API gateway routing configuration","type":"object","properties":{"gateway_node":{"description":"FQDN of the node that acts as the primary API gateway for the domain","example":"gw.myorg.trustgrid.io","type":"string"},"new_cloud_gateway":{"description":"Enable the next-generation cloud gateway routing path","type":"boolean"}}},"id":"schema_252"},"schema_253":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetwork"},"type":"array"},"id":"schema_253"},"schema_254":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetworkAccessPolicy"},"type":"array"},"id":"schema_254"},"schema_255":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetworkAuthorizationGroup"},"type":"array"},"id":"schema_255"},"schema_256":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetworkAuthorizationGroupMembership"},"type":"array"},"id":"schema_256"},"schema_257":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualNetworkInventory"}},"id":"schema_257"},"schema_258":{"kind":"json-schema","data":{"description":"digest","properties":{"digest":{"description":"Digest of the network and its changes","example":"55ca6286e3e4f4fba5d0448333fa99fc5a404a73","type":"string"}},"type":"object"},"id":"schema_258"},"schema_259":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetworkDNSZone"},"type":"array"},"id":"schema_259"},"schema_260":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetworkDNSRecord"},"type":"array"},"id":"schema_260"},"schema_261":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetworkGroup"},"type":"array"},"id":"schema_261"},"schema_262":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetworkGroupMembership"},"type":"array"},"id":"schema_262"},"schema_263":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetworkObject"},"type":"array"},"id":"schema_263"},"schema_264":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/PortForwarding"},"type":"array"},"id":"schema_264"},"schema_265":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VirtualNetworkRoute"},"type":"array"},"id":"schema_265"},"schema_266":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_266"},"schema_267":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ClusterModel"},"type":"array"},"id":"schema_267"},"schema_268":{"kind":"json-schema","data":{"properties":{"acls":{"items":{"properties":{"action":{"enum":["allow","drop","reject"],"type":"string"},"description":{"type":"string"},"dest":{"description":"Destination IP CIDR","type":"string"},"line":{"description":"Line number","maximum":32768,"minimum":1,"type":"number"},"ports":{"description":"Port or port range","type":"string"},"protocol":{"enum":["any","icmp","tcp","udp"],"type":"string"},"source":{"description":"Source IP CIDR","type":"string"}},"required":["protocol","source","dest","action"],"type":"object"},"type":"array"},"darkMode":{"type":"boolean"},"forwarding":{"type":"boolean"},"interfaces":{"items":{"properties":{"cloudRoutes":{"items":{"properties":{"description":{"description":"Route description","example":"My route","type":"string"},"route":{"description":"Route CIDR","example":"192.168.10.0/24","type":"string"}},"type":"object"},"type":"array"},"clusterIP":{"description":"Cluster IP","type":"string"},"clusterRouteTables":{"items":{"description":"Cluster route tables","type":"string"},"type":"array"},"clusterRoutes":{"items":{"description":"Cluster routes","properties":{"description":{"description":"Route description","example":"My route","type":"string"},"route":{"description":"Route CIDR","example":"192.168.10.0/24","type":"string"}},"required":["route"],"type":"object"},"type":"array"},"description":{"description":"Interface description","example":"My interface","type":"string"},"dhcp":{"default":false,"description":"Enable DHCP","example":false,"type":"boolean"},"dhcpPool":{"description":"DHCP pool","type":"string"},"dns":{"items":{"description":"DNS servers","type":"string"},"type":"array"},"duplex":{"description":"Interface duplex","enum":["full","half"],"type":"string"},"gateway":{"description":"Gateway IP","type":"string"},"ip":{"description":"Interface IP","type":"string"},"mode":{"description":"Interface mode","enum":["auto","manual"],"type":"string"},"mtu":{"description":"MTU","example":1500,"maximum":9001,"minimum":1300,"type":"number"},"nic":{"description":"Network interface name","example":"eth0","type":"string"},"routes":{"items":{"properties":{"description":{"description":"Route description","example":"My route","type":"string"},"next":{"description":"Next hop","example":"192.168.10.10","type":"string"},"route":{"description":"Route CIDR","example":"192.168.10.0/24","type":"string"}},"required":["route"],"type":"object"},"type":"array"},"speed":{"description":"Interface speed","type":"number"},"subInterfaces":{"items":{"properties":{"description":{"description":"Interface description","example":"My interface","type":"string"},"ip":{"description":"sub-interface IP","type":"string"},"routes":{"items":{"properties":{"description":{"description":"Route description","example":"My route","type":"string"},"next":{"description":"Next hop","example":"192.168.10.10","type":"string"},"route":{"description":"Route CIDR","example":"192.168.10.0/24","type":"string"}},"required":["route"],"type":"object"},"type":"array"},"vlanID":{"default":1,"description":"VLAN ID","example":1,"maximum":4094,"minimum":1,"type":"number"},"vrf":{"description":"VRF name","example":"default","type":"string"}},"required":["vlanID","ip"],"type":"object"},"type":"array"},"virtual":{"default":false,"description":"Whether the interface is virtual","example":false,"type":"boolean"},"vrf":{"description":"VRF name","example":"default","type":"string"}},"required":["nic"],"type":"object"},"type":"array"},"nats":{"description":"NAT rules (SNAT, DNAT, masquerade) applied to this interface. Duplicate source/dest CIDR pairs are allowed when differentiated by route metric.","items":{"properties":{"description":{"description":"NAT description","type":"string"},"dest":{"description":"NAT destination IP CIDR","type":"string"},"masquerade":{"type":"boolean"},"source":{"description":"NAT source IP CIDR","type":"string"},"toDest":{"description":"Translated dest IP CIDR","type":"string"},"toSource":{"description":"Translated source IP CIDR","type":"string"}},"type":"object"},"type":"array"},"routes":{"items":{"properties":{"description":{"type":"string"},"dest":{"type":"string"},"dev":{"type":"string"},"metric":{"description":"Route metric","maximum":200,"minimum":1,"type":"number"},"via":{"description":"Next hop IP address","type":"string"}},"required":["dest"],"type":"object"},"type":"array"},"rules":{"items":{"properties":{"action":{"enum":["accept","drop","reject","forward","dnat"],"type":"string"},"description":{"description":"Rule description","type":"string"},"dest":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination IP CIDR or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private"},"children":[]}]}]}],"type":"string"},"dmac":{"description":"DNAT MAC address","type":"string"},"dnat":{"description":"DNAT IP address","type":"string"},"iface":{"description":"Interface name","type":"string"},"in":{"type":"string"},"line":{"description":"Rule number","maximum":32768,"minimum":1,"type":"number"},"ports":{"description":"Port or port range","type":"string"},"protocol":{"enum":["any","icmp","tcp","udp"],"type":"string"},"snat":{"description":"Enable SNAT","type":"boolean"},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source IP CIDR or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private"},"children":[]}]}]}],"type":"string"},"vrf":{"description":"VRF name","type":"string"}},"required":["protocol","source","dest","action"],"type":"object"},"type":"array"},"tunnels":{"items":{"properties":{"description":{"type":"string"},"destination":{"type":"string"},"dpdInterval":{"type":"number"},"dpdRetries":{"type":"number"},"enabled":{"type":"boolean"},"ike":{"enum":[1,2],"type":"number"},"ikeCipher":{"enum":["aes128-sha1","aes128-sha256","aes256-sha1","aes256-sha256"],"type":"string"},"ikeGroup":{"enum":[2,5,14,15,16],"type":"number"},"ip":{"type":"string"},"ipsecCipher":{"enum":["aes128-sha1","aes128-sha256","aes256-sha1","aes256-sha256"],"type":"string"},"localId":{"type":"string"},"mtu":{"maximum":10000,"minimum":1000,"type":"number"},"name":{"type":"string"},"networkId":{"type":"string"},"pfs":{"enum":[0,2,5,14,15,16],"type":"number"},"presharedKey":{"type":"string"},"psk":{"type":"string"},"publicKey":{"type":"string"},"rekeyInterval":{"type":"number"},"remoteId":{"type":"string"},"replayWindow":{"enum":[32,64,128,256,512,1024,2048,4096,8192],"type":"number"},"type":{"enum":["ipsec","gre","vnet","wireguard"],"type":"string"},"vrf":{"type":"string"}},"required":["name","enabled","mtu"],"type":"object"},"type":"array"},"vrfs":{"items":{"properties":{"acls":{"items":{"properties":{"action":{"enum":["allow","drop","reject"],"type":"string"},"description":{"description":"ACL description","type":"string"},"dest":{"description":"Destination IP CIDR","type":"string"},"line":{"description":"Line number","maximum":32768,"minimum":1,"type":"number"},"ports":{"description":"Port or port range","type":"string"},"protocol":{"enum":["any","icmp","tcp","udp"],"type":"string"},"source":{"description":"Source IP CIDR","type":"string"}},"required":["protocol","source","dest","action"],"type":"object"},"type":"array"},"description":{"description":"VRF description","type":"string"},"forwarding":{"type":"boolean"},"name":{"description":"VRF name","type":"string"},"nats":{"description":"NAT rules within this VRF. Duplicate source/dest CIDR pairs are allowed when differentiated by route metric.","items":{"properties":{"description":{"description":"NAT description","type":"string"},"dest":{"description":"NAT destination IP CIDR","type":"string"},"masquerade":{"description":"Enable masquerade","type":"boolean"},"source":{"description":"NAT source IP CIDR","type":"string"},"toDest":{"description":"Translated dest IP CIDR","type":"string"},"toSource":{"description":"Translated source IP CIDR","type":"string"}},"type":"object"},"type":"array"},"routes":{"items":{"properties":{"description":{"description":"Route description","example":"My route","type":"string"},"dest":{"description":"Route CIDR","type":"string"},"dev":{"description":"Device name","type":"string"},"metric":{"description":"Route metric","maximum":200,"minimum":1,"type":"number"},"via":{"description":"Next hop IP address","type":"string"}},"required":["dest"],"type":"object"},"type":"array"},"rules":{"items":{"properties":{"action":{"enum":["accept","drop","reject","forward","dnat"],"type":"string"},"description":{"description":"Rule description","type":"string"},"dest":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Destination IP CIDR or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private"},"children":[]}]}]}],"type":"string"},"dmac":{"description":"DNAT MAC address","type":"string"},"dnat":{"description":"DNAT IP address","type":"string"},"iface":{"description":"Interface name","type":"string"},"in":{"type":"string"},"line":{"description":"Rule number","maximum":32768,"minimum":1,"type":"number"},"ports":{"description":"Port or port range","type":"string"},"protocol":{"enum":["any","icmp","tcp","udp"],"type":"string"},"snat":{"description":"Enable SNAT","type":"boolean"},"source":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source IP CIDR or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"public"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private"},"children":[]}]}]}],"type":"string"},"vrf":{"description":"VRF name","type":"string"}},"required":["protocol","source","dest","action"],"type":"object"},"type":"array"}},"required":["name"],"type":"object"},"type":"array"}},"type":"object"},"id":"schema_268"},"schema_269":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VpnClusterNetworkModel"},"type":"array"},"id":"schema_269"},"schema_270":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VpnClusterRouteModel"},"type":"array"},"id":"schema_270"},"schema_271":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VpnClusterInterfaceModel"},"type":"array"},"id":"schema_271"},"schema_272":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VpnClusterServiceModel"},"type":"array"},"id":"schema_272"},"schema_273":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Container"},"type":"array"},"id":"schema_273"},"schema_274":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ContainerInterfaces"},"type":"array"},"id":"schema_274"},"schema_275":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ContainerMount"},"type":"array"},"id":"schema_275"},"schema_276":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ContainerPortMapping"},"type":"array"},"id":"schema_276"},"schema_277":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ContainerVariable"},"type":"array"},"id":"schema_277"},"schema_278":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/ContainerVirtualNetwork"},"type":"array"},"id":"schema_278"},"schema_279":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Volume"},"type":"array"},"id":"schema_279"},"schema_280":{"kind":"json-schema","data":{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]}},"id":"schema_280"},"schema_281":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Node"},"type":"array"},"id":"schema_281"},"schema_282":{"kind":"json-schema","data":{"description":"Node updates (both fields are optional).","properties":{"cluster":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cluster FQDN - requires "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"nodes::cluster"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to modify. If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the node will be removed from the cluster."},"children":[]}]}]}],"example":"mycluster.trustgrid.io","type":"string"},"state":{"description":"Node state","enum":["ACTIVE","INACTIVE"],"type":"string"}},"type":"object"},"id":"schema_282"},"schema_283":{"kind":"json-schema","data":{"description":"Node-level alert threshold configuration","type":"object","properties":{"enabled":{"description":"Whether alert threshold evaluation is active on this node","type":"boolean"},"thresholds":{"description":"Alert rules evaluated against shadow reported telemetry values","type":"array","items":{"type":"object","properties":{"id":{"description":"Rule ID (UUID)","type":"string"},"name":{"description":"Human-readable rule name","type":"string"},"telemetry":{"description":"Telemetry metric to evaluate","enum":["cpu","ram","disk","heap","embflows","latency","bandwidthIn","bandwidthOut","tcpResets","vpnFlows"],"type":"string"},"max":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Upper bound — alert fires when the value exceeds this"},"children":[]}]}]}],"type":"number"},"exceededWindow":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Number of time units the value must continuously exceed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"max"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the alert fires"},"children":[]}]}]}],"type":"number"},"exceededWindowUnit":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Time unit for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"exceededWindow"},"children":[]}]}]}],"enum":["minutes","hours"],"type":"string"}}}}}},"id":"schema_283"},"schema_284":{"kind":"json-schema","data":{"description":"HA cluster configuration for the node","type":"object","properties":{"enabled":{"description":"Whether the node participates in an HA cluster","type":"boolean"},"host":{"description":"Peer IP or hostname used for cluster heartbeat and state sync","type":"string"},"port":{"description":"TCP port used for cluster heartbeat and state sync","type":"integer"},"statusHost":{"description":"Optional dedicated host used for cluster status checks","type":"string"},"statusPort":{"description":"Optional dedicated port used for cluster status checks","type":"integer"},"master":{"description":"True when this node is currently the active master of the cluster pair","type":"boolean"},"updateTime":{"description":"Unix timestamp of the last cluster config change","type":"integer"},"versionCounter":{"description":"Monotonically increasing config version counter","type":"integer"},"masterVersion":{"description":"Config version currently held by the cluster master","type":"integer"}}},"id":"schema_284"},"schema_285":{"kind":"json-schema","data":{"example":{"cert":"myztnahost.mycompany.com","enabled":true,"host":"myztnahost.mycompany.com","port":9927,"wireguardEnabled":true,"wireguardEndpoint":"myztnahost.mycompany.com","wireguardPort":9926},"properties":{"cert":{"description":"APIGW gateway certificate (FQDN)","type":"string"},"enabled":{"description":"Enable this plugin","type":"boolean"},"host":{"description":"APIGW gateway host","type":"string"},"port":{"description":"APIGW gateway port","maximum":65535,"minimum":1,"type":"number"},"wireguardEnabled":{"description":"Enable wireguard","type":"boolean"},"wireguardEndpoint":{"description":"WireGuard endpoint","format":"hostname","type":"string"},"wireguardPort":{"description":"WireGuard port","maximum":65535,"minimum":1,"type":"number"}},"type":"object"},"id":"schema_285"},"schema_286":{"kind":"json-schema","data":{"description":"Gateway config","properties":{"cert":{"description":"Certificate","example":"mygateway.trustgrid.io","type":"string"},"clients":{"items":{"description":"Gateway client","properties":{"enabled":{"description":"Client is allowed to connect","example":true,"type":"boolean"},"name":{"description":"Node or cluster name","example":"mynode","type":"string"}},"type":"object"},"type":"array"},"connectToPublic":{"description":"Connect to public","type":"boolean"},"enabled":{"description":"Enable gateway plugin","type":"boolean"},"host":{"description":"Hostname of the gateway","example":"mygateway.trustgrid.io","type":"string"},"maxClientWriteMbps":{"description":"Max egress MBPS","example":1000,"type":"number"},"maxmbps":{"description":"Max ingress MBPS","example":1000,"type":"number"},"monitorHops":{"description":"Monitor hops","type":"boolean"},"port":{"description":"Port of the gateway","example":8080,"type":"number"},"type":{"description":"Type of gateway","enum":["private","public","hub"],"type":"string"},"udpEnabled":{"description":"Enable UDP","type":"boolean"},"udpPort":{"description":"UDP port","example":8081,"type":"number"}},"required":["enabled"],"type":"object"},"id":"schema_286"},"schema_287":{"kind":"json-schema","data":{"description":"SNMP config","properties":{"authPassphrase":{"description":"Auth passphrase","example":"myauthpass","type":"string"},"authProtocol":{"description":"Auth passphrase","enum":["SHA","MD5"],"type":"string"},"enabled":{"description":"Enable SNMP plugin","type":"boolean"},"engineId":{"description":"Engine ID","example":"myengineid","type":"string"},"interface":{"description":"Interface","example":"eth0","type":"string"},"port":{"description":"Port","example":161,"type":"number"},"privacyPassphrase":{"description":"Privacy passphrase","example":"myprivpass","type":"string"},"privacyProtocol":{"description":"Privacy protocol","enum":["AES128","AES192","AES256","DES"],"type":"string"},"username":{"description":"Username","example":"myuser","type":"string"}},"required":["enabled"],"type":"object"},"id":"schema_287"},"schema_288":{"kind":"json-schema","data":{"type":"integer","enum":[1]},"id":"schema_288"},"schema_289":{"kind":"json-schema","data":{"type":"object","properties":{"nic":{"type":"string","description":"Network interface name to filter route tables. Omit to return all.","example":"eth0"}}},"id":"schema_289"},"schema_290":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"type":"object","properties":{"tables":{"type":"array","items":{"type":"object","additionalProperties":true}}}}}},"id":"schema_290"},"schema_291":{"kind":"json-schema","data":{"type":"object","properties":{"action":{"type":"string","enum":["LIST"],"default":"LIST","description":"Action to perform on the datastore"},"filename":{"type":"string","description":"File or directory name for operations that target a specific entry"}}},"id":"schema_291"},"schema_292":{"kind":"json-schema","data":{"type":"object","additionalProperties":true},"id":"schema_292"},"schema_293":{"kind":"json-schema","data":{"type":"object","properties":{"action":{"type":"string","enum":["read","delete"],"default":"read","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — return matching flows"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — terminate matching flows"},"children":[]}]}]}]}]},"protocol":{"type":"string","enum":["icmp","tcp","udp","any"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Protocol filter. Omit or use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to match all."},"children":[]}]}]}]},"source":{"type":"string","description":"Source IP or CIDR filter","example":"10.0.0.0/24"},"sourcePort":{"type":"integer","description":"Source port filter"},"dest":{"type":"string","description":"Destination IP or CIDR filter","example":"192.168.1.5"},"destPort":{"type":"integer","description":"Destination port filter"},"containerId":{"type":"string","description":"Filter flows belonging to a specific container"},"networkId":{"type":"integer","description":"Filter flows on a specific virtual network ID"}}},"id":"schema_293"},"schema_294":{"kind":"json-schema","data":{"type":"object","properties":{"result":{"oneOf":[{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Map of protocol to flow list (action=read)"},"children":[]}]}]}],"properties":{"icmp":{"type":"array","items":{"$ref":"#/components/schemas/NodeFlowEntry"}},"tcp":{"type":"array","items":{"$ref":"#/components/schemas/NodeFlowEntry"}},"udp":{"type":"array","items":{"$ref":"#/components/schemas/NodeFlowEntry"}}}},{"type":"string","enum":["success"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returned when action=delete"},"children":[]}]}]}]}]}}},"id":"schema_294"},"schema_295":{"kind":"json-schema","data":{"type":"object","required":["dest"],"properties":{"dest":{"type":"string","description":"Destination node FQDN to send data to","example":"edge-node.example.trustgrid.io"},"gwPath":{"type":"string","description":"Gateway path ID to use. Omit for default path."},"bytes":{"type":"integer","description":"Number of bytes to send","default":10000000},"messageSize":{"type":"integer","description":"Size of each message chunk in bytes","default":50000},"windowSize":{"type":"integer","description":"Flow-control window size in bytes","default":1000000}}},"id":"schema_295"},"schema_296":{"kind":"json-schema","data":{"type":"object","required":["dest"],"properties":{"dest":{"type":"string","description":"Destination node FQDN to ping","example":"gateway.example.trustgrid.io"},"gwPath":{"type":"string","description":"Gateway path ID to use. Omit for default path."},"interval":{"type":"integer","description":"Interval between echo packets in seconds","default":5},"size":{"type":"integer","description":"Echo payload size in bytes","default":64},"sendJson":{"type":"boolean","description":"If true, the node accepts JSON-formatted echo data","default":false}}},"id":"schema_296"},"schema_297":{"kind":"json-schema","data":{"type":"object","properties":{"showClusterRoutes":{"type":"boolean","description":"Include cluster-level routes in the output","default":false},"enableLog":{"type":"boolean","description":"Enable debug logging during route collection","default":true}}},"id":"schema_297"},"schema_298":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"type":"object","properties":{"available":{"type":"integer","description":"Total number of available paths"},"connected":{"type":"integer","description":"Number of connected peers in the node's domain"},"domains":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Domain FQDN"},"routes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Peer node name"},"path":{"type":"string","description":"Gateway path ID in use"},"rtt":{"type":"number","description":"Mean round-trip time in milliseconds"},"connected":{"type":"boolean","description":"Whether the peer is currently connected"},"client":{"type":"boolean","description":"True if the peer is a hub or management node"},"udp":{"type":"boolean","description":"Whether the connection uses UDP tunneling"},"udpPort":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UDP port in use (when udp=true)"},"children":[]}]}]}]},"ip":{"type":"string","description":"Remote IP address"},"port":{"type":"integer","description":"Remote port"},"receivedMbps":{"type":"number","description":"Average receive throughput in Mbps since last reset"},"sentMbps":{"type":"number","description":"Average transmit throughput in Mbps since last reset"},"clusterName":{"type":"string","description":"Cluster name if the peer belongs to a cluster"},"clusterMaster":{"type":"boolean","description":"True if this peer is the cluster master"}}}}}}}}}}},"id":"schema_298"},"schema_299":{"kind":"json-schema","data":{"type":"object","required":["action"],"properties":{"action":{"type":"string","enum":["GET","RESET","RESET_ALL"],"description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — return hit counts"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — reset counters for matching rules"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESET_ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — reset all counters"},"children":[]}]}]}]}]},"trackerID":{"type":"string","description":"Filter by specific tracker ID"},"networkName":{"type":"string","description":"Filter by virtual network name"},"interfaceName":{"type":"string","description":"Filter by interface name"},"insideCIDR":{"type":"string","description":"Filter by inside (local) CIDR","example":"10.0.0.0/24"},"outsideCIDR":{"type":"string","description":"Filter by outside (translated) CIDR","example":"172.16.0.0/16"},"networkGroup":{"type":"string","description":"Filter by network group name"}}},"id":"schema_299"},"schema_300":{"kind":"json-schema","data":{"type":"object","properties":{"plugin":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Plugin name to filter. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omit to receive all plugins."},"children":[]}]}]}],"example":"network"}}},"id":"schema_300"},"schema_301":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"type":"object","properties":{"message":{"type":"string","example":"Node host will restart"}}}}},"id":"schema_301"},"schema_302":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"type":"object","properties":{"message":{"type":"string","example":"Node service will restart"}}}}},"id":"schema_302"},"schema_303":{"kind":"json-schema","data":{"type":"object","properties":{"skipUnattended":{"type":"boolean","description":"If true, skip the unattended-upgrade step","default":false}}},"id":"schema_303"},"schema_304":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"type":"object","properties":{"status":{"type":"string","enum":["Upgrade in progress","Existing upgrade is already in progress"]}}}}},"id":"schema_304"},"schema_305":{"kind":"json-schema","data":{"type":"object","properties":{"action":{"type":"string","enum":["download","upload","both"],"default":"both","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"download"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — test download speed only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upload"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — test upload speed only"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"both"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — test download then upload"},"children":[]}]}]}]}]}}},"id":"schema_305"},"schema_306":{"kind":"json-schema","data":{"type":"object","required":["iface","host"],"properties":{"iface":{"type":"string","description":"Network interface to send ARP packets from","example":"eth0"},"host":{"type":"string","description":"Target host IP address","example":"192.168.1.1"}}},"id":"schema_306"},"schema_307":{"kind":"json-schema","data":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","description":"Target host IP or hostname","example":"8.8.8.8"},"options":{"type":"string","description":"Additional MTR command-line options (space-separated)","example":"--report"},"cols":{"type":"integer","description":"Terminal column width for MTR display","default":80}}},"id":"schema_307"},"schema_308":{"kind":"json-schema","data":{"type":"object","required":["host","port"],"properties":{"source":{"type":"string","description":"Source IP address to bind to","default":"127.0.0.1","example":"192.168.1.10"},"host":{"type":"string","description":"Target host IP or hostname","example":"10.0.0.1"},"port":{"type":"integer","description":"Target TCP port","example":443}}},"id":"schema_308"},"schema_309":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"type":"object","properties":{"message":{"type":"string","description":"netcat standard output and error"},"exitCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Process exit code. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates success."},"children":[]}]}]}]}}}}},"id":"schema_309"},"schema_310":{"kind":"json-schema","data":{"type":"object","required":["network","host","port"],"properties":{"network":{"type":"string","description":"Virtual network name whose namespace to test from","example":"virtual-network"},"host":{"type":"string","description":"Target host IP or hostname","example":"10.0.0.1"},"port":{"type":"integer","description":"Target TCP port","example":80}}},"id":"schema_310"},"schema_311":{"kind":"json-schema","data":{"type":"object","required":["host","network"],"properties":{"host":{"type":"string","description":"Target IP or hostname to ping","example":"10.0.0.1"},"network":{"type":"string","description":"Virtual network name to use as the source namespace","example":"virtual-network"}}},"id":"schema_311"},"schema_312":{"kind":"json-schema","data":{"type":"object","required":["host"],"properties":{"source":{"type":"string","description":"Source interface IP address","default":"127.0.0.1","example":"192.168.1.10"},"host":{"type":"string","description":"Target IP or hostname to ping","example":"8.8.8.8"}}},"id":"schema_312"},"schema_313":{"kind":"json-schema","data":{"type":"object","additionalProperties":true,"description":"tcpdump session parameters"},"id":"schema_313"},"schema_314":{"kind":"json-schema","data":{"type":"object","required":["host"],"properties":{"host":{"type":"string","description":"Target IP or hostname","example":"8.8.8.8"},"filter":{"type":"string","description":"Additional traceroute flags (space-separated)","default":"-n"},"iface":{"type":"string","description":"Network interface to route through","example":"eth0"}}},"id":"schema_314"},"schema_315":{"kind":"json-schema","data":{"type":"object","properties":{"network":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual network name to capture. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omit for all networks."},"children":[]}]}]}]},"protocol":{"type":"string","enum":["icmp","tcp","udp","any"],"description":"Protocol filter"},"peer":{"type":"string","description":"Remote peer name filter"},"host":{"type":"string","description":"Source or destination IP filter","example":"10.0.0.1"},"port":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Port filter. Supports single port ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"443"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), range ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1024-2048"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), or operator prefix ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt:1024"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt:1024"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ne:443"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]},"tcpflags":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TCP flag filter. Combine flag letters: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"S"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (SYN), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (PSH), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"U"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (URG), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"F"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (FIN), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"R"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (RST), "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (ACK). Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to match all."},"children":[]}]}]}],"example":"S"}}},"id":"schema_315"},"schema_316":{"kind":"json-schema","data":{"type":"object","required":["network"],"properties":{"action":{"type":"string","enum":["get","generate","save"],"default":"get","description":"Key operation to perform"},"network":{"type":"string","description":"Virtual network name","example":"virtual-network"},"key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base64-encoded 32-byte X25519 private key. Required when action=save."},"children":[]}]}]}],"example":"dGhpcyBpcyBhIDMyLWJ5dGUgcHJpdmF0ZSBrZXk="}}},"id":"schema_316"},"schema_317":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"type":"object","description":"JWK (JSON Web Key) representing the X25519 public key","properties":{"kid":{"type":"string","description":"Key ID"},"kty":{"type":"string","example":"EC"},"crv":{"type":"string","example":"X25519"},"x":{"type":"string","description":"Base64-encoded public key value"}}}}},"id":"schema_317"},"schema_318":{"kind":"json-schema","data":{"type":"object","required":["network"],"properties":{"network":{"type":"string","description":"Virtual network name","example":"virtual-network"}}},"id":"schema_318"},"schema_319":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"type":"object","properties":{"nats":{"type":"array","items":{"type":"object","properties":{"proto":{"type":"string","enum":["tcp","udp"]},"src":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Source translation mapping ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"originalIp:port->translatedIp:port"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"dest":{"type":"string","description":"Destination translation mapping"},"state":{"type":"string","description":"TCP connection state (TCP flows only)"},"def":{"type":"boolean","description":"True if the flow is defunct"},"flags":{"type":"integer","description":"TCP flag bits when the flow became defunct"}}}}}}}},"id":"schema_319"},"schema_320":{"kind":"json-schema","data":{"type":"object","properties":{"networkId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by virtual network ID (takes precedence over "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"network"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},"network":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual network name filter. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return all networks."},"children":[]}]}]}],"example":"virtual-network"},"domain":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Domain filter when combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"network"},"children":[]}]}]}]},"ip":{"type":"string","description":"Filter routes that cover this IP address","example":"10.0.0.5"},"dest":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by destination node name. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"any"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to return all."},"children":[]}]}]}]}}},"id":"schema_320"},"schema_321":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"type":"object","properties":{"networks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Virtual network name"},"routes":{"type":"array","items":{"type":"object","properties":{"cidr":{"type":"string","description":"Route destination CIDR","example":"10.0.0.0/24"},"dest":{"type":"string","description":"Destination node FQDN"},"path":{"type":"string","description":"Gateway path ID (if applicable)"},"metric":{"type":"integer","description":"Route metric (lower is preferred)"},"available":{"type":"boolean","description":"Whether the route is active and reachable"},"master":{"type":"string","description":"Active cluster master node (cluster routes only)"},"nodeId":{"type":"string","description":"Destination node ID"},"monitors":{"type":"array","description":"Route monitor states","items":{"type":"object","properties":{"name":{"type":"string"},"state":{"type":"string","enum":["ok","fail"]}}}}}}}}}}}}}},"id":"schema_321"},"schema_322":{"kind":"json-schema","data":{"type":"object","properties":{"action":{"type":"string","enum":["list","kill"],"default":"list","description":[{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"list"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — return active Wireguard client sessions"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kill"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — terminate matching sessions"},"children":[]}]}]}]}]},"network":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual network name filter. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omit for all networks."},"children":[]}]}]}]},"app":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Application ID filter. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omit for all apps."},"children":[]}]}]}]},"session":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ZTNA session ID filter. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or omit for all sessions."},"children":[]}]}]}]}}},"id":"schema_322"},"schema_323":{"kind":"json-schema","data":{"type":"object","properties":{"output":{"oneOf":[{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client list (action=list)"},"children":[]}]}]}],"properties":{"network":{"type":"string"},"clients":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Client peer name"},"endpoint":{"type":"string","description":"Remote endpoint address and port"},"session":{"type":"string","description":"ZTNA session ID"},"state":{"type":"string","enum":["active"]},"connected":{"type":"integer","description":"Seconds since connected (only present when up)"},"sent":{"type":"integer","description":"Bytes sent"},"recv":{"type":"integer","description":"Bytes received"},"lastHandshake":{"type":"integer","description":"Seconds since last Wireguard handshake"}}}}}},{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kill result (action=kill)"},"children":[]}]}]}],"properties":{"message":{"type":"string","example":"Killed 1 sessions"}}}]}}},"id":"schema_323"},"schema_324":{"kind":"json-schema","data":{"type":"string","example":"gateway-routes"},"id":"schema_324"},"schema_325":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/NodeTriggerContainerActionRequest"},{"$ref":"#/components/schemas/NodeTriggerContainerImageRequest"},{"$ref":"#/components/schemas/NodeTriggerContainerStatusRequest"},{"$ref":"#/components/schemas/NodeTriggerBGPRequest"},{"type":"object","additionalProperties":true}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional event-specific payload. The request body shape depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{event}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" being executed."},"children":[]}]}]}]},"id":"schema_325"},"schema_326":{"kind":"json-schema","data":{"anyOf":[{"type":"boolean"},{"$ref":"#/components/schemas/NodeTriggerContainerActionResponse"},{"$ref":"#/components/schemas/NodeTriggerContainerStatusResponse"},{"$ref":"#/components/schemas/NodeTriggerContainerImageListResponse"},{"$ref":"#/components/schemas/NodeTriggerContainerImageDeleteResponse"},{"$ref":"#/components/schemas/NodeTriggerBGPGetResponse"},{"$ref":"#/components/schemas/NodeTriggerBGPRestartResponse"}]},"id":"schema_326"},"schema_327":{"kind":"json-schema","data":{"type":"integer","format":"int64"},"id":"schema_327"},"schema_328":{"kind":"json-schema","data":{"items":{"properties":{"bytes":{"description":"The number of bytes in the bucket.","format":"int64","type":"integer"},"count":{"description":"The number of flows in the bucket.","format":"int64","type":"integer"},"t":{"description":"The time of the bucket in Unix timestamp format.","format":"int64","type":"integer"}},"type":"object"},"type":"array"},"id":"schema_328"},"schema_329":{"kind":"json-schema","data":{"description":"mkdir","properties":{"filename":{"description":"filename","type":"string"}},"required":["filename"],"type":"object"},"id":"schema_329"},"schema_330":{"kind":"json-schema","data":{"description":"Data Store HTTP Download Request","properties":{"algo":{"description":"Hashing algorithm of the file - MD5, SHA1, or SHA-256","example":"MD5","type":"string"},"filename":{"description":"Target filename","example":"file.iso","type":"string"},"hash":{"description":"Hash of the file","example":"07c43d77ab8d30cee094ce09b14f87fa","type":"string"},"location":{"description":"Target destination directory in data store","example":"/isos","type":"string"},"uri":{"description":"URI of source file","example":"http://example.com/file.iso","type":"string"}},"type":"object"},"id":"schema_330"},"schema_331":{"kind":"json-schema","data":{"description":"Data Store HTTP Upload Request","properties":{"filePath":{"description":"File path in data store","example":"file.iso","type":"string"},"multipart":{"description":"Multipart upload","example":false,"type":"boolean"},"uri":{"description":"Destination URI","example":"http://example.com/file.iso","type":"string"}},"type":"object"},"id":"schema_331"},"schema_332":{"kind":"json-schema","data":{"description":"File List","properties":{"files":{"items":{"$ref":"#/components/schemas/DataStoreFile"},"type":"array"}},"type":"object"},"id":"schema_332"},"schema_333":{"kind":"json-schema","data":{"description":"Data Store S3 Download Request","properties":{"location":{"description":"Target destination in data store","example":"your-file.iso","type":"string"},"uri":{"description":"S3 location of source file","example":"s3://your-bucket/your-file.iso","type":"string"}},"type":"object"},"id":"schema_333"},"schema_334":{"kind":"json-schema","data":{"description":"Data Store S3 Upload Request","properties":{"bucketDest":{"description":"S3 destination","example":"s3://your-bucket/your-destination.iso","type":"string"},"filePath":{"description":"File path in data store","example":"file.iso","type":"string"}},"type":"object"},"id":"schema_334"},"schema_335":{"kind":"json-schema","data":{"description":"Task List","properties":{"tasks":{"items":{"$ref":"#/components/schemas/DataStoreTask"},"type":"array"}},"type":"object"},"id":"schema_335"},"schema_336":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"stats":{"description":"Per-peer RTT measurements for this time bucket","type":"array","items":{"type":"object","properties":{"time":{"description":"Unix timestamp in milliseconds of the start of the 1-minute interval. Note: query params startDate/endDate use Unix seconds.","type":"number"},"node":{"description":"Friendly name of the VPN peer node being measured","type":"string"},"numRtt":{"description":"Number of RTT probes sent in this interval","type":"number"},"minRtt":{"description":"Minimum round-trip time in milliseconds","type":"number"},"maxRtt":{"description":"Maximum round-trip time in milliseconds","type":"number"},"meanRtt":{"description":"Mean round-trip time in milliseconds","type":"number"},"stdRtt":{"description":"Standard deviation of RTT in milliseconds","type":"number"},"hops":{"description":"Per-hop traceroute telemetry, if available","type":"array","items":{"type":"object","properties":{"hop":{"description":"Hop number (1-based)","type":"number"},"ip":{"description":"IP address of this hop","type":"string"},"fqdn":{"description":"Reverse DNS name of this hop, if resolved","type":"string"},"minRtt":{"type":"number"},"maxRtt":{"type":"number"},"meanRtt":{"type":"number"},"numRtt":{"type":"number"}}}}}}}}}},"id":"schema_336"},"schema_337":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VpnNodeNetworkModel"},"type":"array","description":""},"id":"schema_337"},"schema_338":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VpnNodeRouteModel"},"type":"array"},"id":"schema_338"},"schema_339":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VpnNodeInterfaceModel"},"type":"array"},"id":"schema_339"},"schema_340":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/VpnNodeServiceModel"},"type":"array"},"id":"schema_340"},"schema_341":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Upgrade"},"type":"array"},"id":"schema_341"},"schema_342":{"kind":"json-schema","data":{"description":"UID","properties":{"uid":{"description":"Unique ID","example":"a9f7cfec-da06-4822-b4ab-389e4ad51931","type":"string"}},"title":"UID","type":"object"},"id":"schema_342"},"schema_343":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/UpgradeLog"},"type":"array"},"id":"schema_343"},"schema_344":{"kind":"json-schema","data":{"description":"Note","type":"string"},"id":"schema_344"},"schema_345":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RepositoryModel"},"type":"array"},"id":"schema_345"},"schema_346":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/RepositoryTagModel"},"type":"array"},"id":"schema_346"},"schema_347":{"kind":"json-schema","data":{"type":"string","enum":["eq","ne","gt","gte","lt","lte"]},"id":"schema_347"},"schema_348":{"kind":"json-schema","data":{"type":"array","items":{"type":"number"}},"id":"schema_348"},"schema_349":{"kind":"json-schema","data":{"items":{"description":"FlowLog","properties":{"nodeId":{"description":"ID of the node that logged this flow","type":"string"},"sourceNode":{"description":"Source node name","example":"mynode","type":"string"},"sourceIP":{"description":"Source IP address","example":"2.2.2.2","type":"string"},"sourcePort":{"description":"Source port","example":1234,"type":"number"},"sourceBytes":{"description":"Source bytes transferred","example":100,"type":"number"},"destNode":{"description":"Destination node name","example":"mynode","type":"string"},"destIP":{"description":"Destination IP address","example":"1.1.1.1","type":"string"},"destPort":{"description":"Destination port","example":1234,"type":"number"},"destBytes":{"description":"Destination bytes transferred","example":100,"type":"number"},"startTime":{"description":"Start time of the flow (ISO 8601)","example":"2022-11-01T22:46:01.765Z","type":"string"},"endTime":{"description":"End time of the flow (ISO 8601)","example":"2022-11-01T22:46:02.730Z","type":"string"},"protocol":{"description":"Protocol","enum":["TCP","UDP","ICMP","UNKNOWN"],"example":"TCP","type":"string"},"tcpFlags":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"TCP flags as a bitmask encoded decimal string:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0x01 - FIN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0x02 - SYN"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0x04 - RST"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0x08 - PSH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0x10 - ACK"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0x20 - URG"},"children":[]}]}]}]}],"example":"2","type":"string"},"flags":{"description":"Additional flow flags as a decimal string","example":"40019","type":"string"},"activityID":{"description":"Threat Intelligence activity ID (if applicable)","example":"9aa2bbc3-4265-475b-b977-c94b1ee25a1f","type":"string"},"meta":{"description":"Additional metadata about the flow event. Contents vary by event source and may include arbitrary string, numeric, or nested values. Nullable.","type":"object","additionalProperties":true,"nullable":true}},"type":"object"},"type":"array"},"id":"schema_349"},"schema_350":{"kind":"json-schema","data":{"type":"object","properties":{"x-total-count":{"type":"number","description":"Total number of flows matching query"}}},"id":"schema_350"},"schema_351":{"kind":"json-schema","data":{"type":"integer","default":1},"id":"schema_351"},"schema_352":{"kind":"json-schema","data":{"type":"integer","default":50,"maximum":200},"id":"schema_352"},"schema_353":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/AuthAuditRecord"}},"id":"schema_353"},"schema_354":{"kind":"json-schema","data":{"type":"object","properties":{"x-total-count":{"type":"integer","description":"Total number of records matching the query"}}},"id":"schema_354"},"schema_355":{"kind":"json-schema","data":{"type":"integer","default":50,"maximum":10000},"id":"schema_355"},"schema_356":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ChangeAuditRecord"}},"id":"schema_356"},"schema_357":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/NodeAuditRecord"}},"id":"schema_357"},"schema_358":{"kind":"json-schema","data":{"items":{"description":"ConfigChange","properties":{"auditType":{"description":"Type of change","enum":["change","create","delete","action"],"type":"string"},"ip":{"description":"IP address of the client that initiated the change","example":"44.44.44.43","type":"string"},"itemId":{"description":"Unique ID of the item that was changed","example":"19084f81-5668-41ee-adbe-295e4c65531a","type":"string"},"itemType":{"description":"Type of the item that was changed","example":"Node","type":"string"},"message":{"description":"Message describing the change","example":"Node license created","type":"string"},"timestamp":{"description":"Unix timestamp when the change happened","example":1729533326,"type":"number"},"uid":{"description":"Unique ID of the change","example":"8845f684-4ffe-4b01-a62f-5619a7eae486","type":"string"},"userName":{"description":"User name of the client that initiated the change","example":"admin@trustgrid.io","type":"string"},"org":{"description":"Organization ID","type":"string"},"type":{"description":"Object type discriminator","example":"AuditLog","type":"string"}},"type":"object"},"type":"array"},"id":"schema_358"},"schema_359":{"kind":"json-schema","data":{"type":"object","properties":{"x-cursor":{"type":"string","description":"Continuation cursor for the next query"}}},"id":"schema_359"},"schema_360":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"uid":{"description":"Unique identifier","type":"string"},"fqdn":{"description":"FQDN of the node that performed the action","type":"string"},"category":{"description":"Action category (e.g. \"Node Action\")","type":"string"},"value":{"description":"Human-readable description of the action taken","type":"string"},"timestamp":{"description":"Unix epoch timestamp (seconds) when the action occurred","type":"integer"},"expires":{"description":"Unix epoch timestamp (seconds) when this audit record expires","type":"integer"},"org":{"description":"Organization ID","type":"string"}}}},"id":"schema_360"},"schema_361":{"kind":"json-schema","data":{"type":"array","items":{"type":"object","properties":{"uid":{"description":"Unique identifier","type":"string"},"userId":{"description":"User who performed the authentication","example":"admin@example.com","type":"string"},"message":{"description":"Human-readable description (e.g. \"Portal login (Local Authentication)\")","type":"string"},"source":{"description":"Authentication source (e.g. \"portal\")","type":"string"},"ip":{"description":"IP address of the client","type":"string"},"timestamp":{"description":"Unix epoch timestamp (seconds) when the event occurred","type":"integer"},"expires":{"description":"Unix epoch timestamp (seconds) when this audit record expires","type":"integer"},"orgId":{"description":"Organization ID","type":"string"},"type":{"description":"Object type discriminator","example":"AuthAudit","type":"string"}}}},"id":"schema_361"},"schema_362":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Certificate"},"type":"array"},"id":"schema_362"},"schema_363":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Group"},"type":"array"},"id":"schema_363"},"schema_364":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/IdpGroup"},"type":"array"},"id":"schema_364"},"schema_365":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/GroupMember"},"type":"array"},"id":"schema_365"},"schema_366":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/IdentityProviderModel"},"type":"array"},"id":"schema_366"},"schema_367":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ObservabilityExporter"}},"id":"schema_367"},"schema_368":{"kind":"json-schema","data":{"type":"object","properties":{"uid":{"type":"string"}}},"id":"schema_368"},"schema_369":{"kind":"json-schema","data":{"$ref":"#/components/schemas/OrderPriority"},"id":"schema_369"},"schema_370":{"kind":"json-schema","data":{"$ref":"#/components/schemas/OrderStatus"},"id":"schema_370"},"schema_371":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_371"},"schema_372":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_372"},"schema_373":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/OrderModel"},"type":"array"},"id":"schema_373"},"schema_374":{"kind":"json-schema","data":{"type":"object","properties":{"x-total-count":{"type":"integer","description":"Total number of orders matching the query"}}},"id":"schema_374"},"schema_375":{"kind":"json-schema","data":{"additionalProperties":{"type":"integer"},"type":"object"},"id":"schema_375"},"schema_376":{"kind":"json-schema","data":{"properties":{"attachment":{"items":{"type":"string","format":"binary"},"type":"array"}},"type":"object"},"id":"schema_376"},"schema_377":{"kind":"json-schema","data":{"properties":{"body":{"type":"string"}},"type":"object"},"id":"schema_377"},"schema_378":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/OrderAudit"},"type":"array"},"id":"schema_378"},"schema_379":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Policy"},"type":"array"},"id":"schema_379"},"schema_380":{"kind":"json-schema","data":{"type":"object","properties":{"clientId":{"type":"string"},"secret":{"type":"string"}}},"id":"schema_380"},"schema_381":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/ServiceUser"}},"id":"schema_381"},"schema_382":{"kind":"json-schema","data":{"type":"object","properties":{"name":{"type":"string"},"policyIds":{"type":"array","items":{"type":"string"}}}},"id":"schema_382"},"schema_383":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},"id":"schema_383"},"schema_384":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/UserModel"},"type":"array"},"id":"schema_384"},"schema_385":{"kind":"json-schema","data":{"properties":{"email":{"description":"User's email","type":"string"},"policyId":{"description":"ID of the policy to be applied to the user upon account creation","type":"string"}},"required":["email","policyId"],"type":"object"},"id":"schema_385"},"schema_386":{"kind":"json-schema","data":{"properties":{"email":{"description":"User's email","type":"string"},"idp":{"description":"ID of the IDP to be used for the user","type":"string"},"policyIds":{"description":"IDs of the policy/policies to be applied to the user","items":{"type":"string"},"type":"array"}},"required":["email","policyIds","idp"],"type":"object"},"id":"schema_386"},"schema_387":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/GroupModel"},"type":"array"},"id":"schema_387"},"schema_388":{"kind":"json-schema","data":{"properties":{"groupId":{"description":"Group ID","type":"string"}},"required":["groupId"],"type":"object"},"id":"schema_388"}},"exampleStore":{},"securitySchemeStore":{"JWTAuthorizer":{"id":"JWTAuthorizer","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JWT Bearer token. Send as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer <token>"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Obtain via the Trustgrid portal or service user credentials. See https://docs.trustgrid.io/docs/user-management/api-access/"},"children":[]}]}]}]}},"servers":[{"url":"/_mock/","isMockServer":true,"description":"Mock server"},{"url":"https://api.trustgrid.io"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/index.json?download"},{"url":"/_bundle/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Trustgrid Management API","description":"The Trustgrid Management API provides programmatic access to manage the Trustgrid\nnetwork infrastructure platform. Trustgrid connects distributed nodes (appliances and\nagents) into secure overlay networks with centralized management.\n\n## Key Concepts\n\n- **Nodes**: The core compute units — either `Node` (physical/VM appliance) or `Agent`\n  (lightweight software agent on a device). Identified by UUID (`uid`) and FQDN.\n- **Clusters**: High-availability groups of nodes sharing configuration.\n- **Domains**: Logical groupings of nodes within an organization.\n- **Virtual Networks**: Layer-3 overlay networks (`DomainNetwork`) created within a domain,\n  enabling zero-trust connectivity between nodes. Each network has access policies,\n  DNS config, routes, and port forwarding rules.\n- **Tags**: Key-value metadata attached to nodes and clusters for grouping and permissions.\n- **Shadow**: Each node has an AWS IoT Device Shadow with `desired` (target config) and\n  `reported` (current state) halves. The `reported` shadow contains telemetry using\n  dot-notation keys (e.g. `nic.eth0.mtu`, `node-core.version`).\n\n## Authentication\n\nAll API requests require a JWT Bearer token in the `Authorization` header:\n```\nAuthorization: Bearer <token>\n```\nTokens are obtained via the Trustgrid portal or programmatically via service user\ncredentials. See [API Access docs](https://docs.trustgrid.io/docs/user-management/api-access/).\n\n## Permissions\n\nMost endpoints require specific permissions (noted in each endpoint's description).\nPermissions follow the pattern `resource::action` (e.g. `nodes::read`, `virtual-networks::modify`).\n"}},"baseSlug":"/","routesMapping":{}}