{"items":[{"type":"link","label":"Shared Resources API","link":"/api-reference/shared-resources/shared-api","routeSlug":"/api-reference/shared-resources/shared-api","content":{"contentType":"overview","meta":{"name":"Shared Resources API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"shared-api.json","url":"/_bundle/API Reference/Shared Resources/shared-api.json?download"},{"kind":"download","label":"shared-api.yaml","url":"/_bundle/API Reference/Shared Resources/shared-api.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"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":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Shared Resources API (2026-09-05)","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":"Shared resource management APIs for proxies, groups, and tags. These resources are used by both Browser Profiles and Cloud Phones. Base URL: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"http://127.0.0.1:40000"},"children":[]}]}]}]}],"sectionId":"/api-reference/shared-resources/shared-api"}],"sectionId":"/api-reference/shared-resources/shared-api"}]}]}},{"type":"group","label":"Proxies","link":"/api-reference/shared-resources/shared-api/proxies","routeSlug":"/api-reference/shared-resources/shared-api/proxies","items":[{"label":"Getting a list of proxies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/proxies/queryproxyinfopageusingpost","routeSlug":"/api-reference/shared-resources/shared-api/proxies/queryproxyinfopageusingpost","metadata":{"seo":{"title":"Getting a list of proxies","description":"List the team's proxy configurations, page by page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"queryProxyInfoPageUsingPOST","name":"Getting a list of proxies","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1proxyInfo~1page/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting a list of proxies","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 the team's proxy configurations, page by page."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": none. Read-only. Safe to retry with bounded backoff."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": passwords are withheld from ordinary members and for cloud and dynamic proxies. Dynamic proxies appear here but are managed elsewhere and cannot be edited through the proxy endpoints."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2537","exampleIds":["paths/~1api~1proxyInfo~1page/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2537","exampleIds":["paths/~1api~1proxyInfo~1page/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1proxyInfo~1page/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proxyInfo/page","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2537","exampleIds":["paths/~1api~1proxyInfo~1page/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/proxyInfo/page","href":"proxies/queryproxyinfopageusingpost","openApiOperationId":"queryProxyInfoPageUsingPOST","summary":"Getting a list of proxies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2537","exampleIds":["paths/~1api~1proxyInfo~1page/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2537","exampleIds":["paths/~1api~1proxyInfo~1page/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.dataList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the records for the requested page and is an empty array when there are no matches; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describe the paging."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2538","exampleIds":["paths/~1api~1proxyInfo~1page/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2538","exampleIds":["paths/~1api~1proxyInfo~1page/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1proxyInfo~1page/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2538","exampleIds":["paths/~1api~1proxyInfo~1page/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2538","exampleIds":["paths/~1api~1proxyInfo~1page/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proxies/queryproxyinfopageusingpost"}],"panels":[]}]},"httpPath":"/api/proxyInfo/page"},{"label":"Adding proxy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/proxies/addusingpost","routeSlug":"/api-reference/shared-resources/shared-api/proxies/addusingpost","metadata":{"seo":{"title":"Adding proxy","description":"Create a proxy configuration in the team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addUsingPOST","name":"Adding proxy","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1proxyInfo~1add/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adding proxy","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a proxy configuration in the team."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proxyPort"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required and must be 1–65535, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"proxyProvider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be a recognised provider."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": inserts a proxy record and returns its id, ready to bind to profiles. Nothing is sent to the proxy vendor."},"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":"Completion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": synchronous."},"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":"Retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"there is no name or configuration uniqueness check."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Posting the same body twice produces two proxies with two ids. After a timeout, search "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/proxyInfo/page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before resending."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documented business errors: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/getting-started/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for what each code means. Any operation can additionally return the common codes."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2539","exampleIds":["paths/~1api~1proxyInfo~1add/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2539","exampleIds":["paths/~1api~1proxyInfo~1add/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1proxyInfo~1add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proxyInfo/add","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2539","exampleIds":["paths/~1api~1proxyInfo~1add/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/proxyInfo/add","href":"proxies/addusingpost","openApiOperationId":"addUsingPOST","summary":"Adding proxy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2539","exampleIds":["paths/~1api~1proxyInfo~1add/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2539","exampleIds":["paths/~1api~1proxyInfo~1add/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a single integer value."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2540","exampleIds":["paths/~1api~1proxyInfo~1add/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2540","exampleIds":["paths/~1api~1proxyInfo~1add/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1proxyInfo~1add/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2540","exampleIds":["paths/~1api~1proxyInfo~1add/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2540","exampleIds":["paths/~1api~1proxyInfo~1add/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proxies/addusingpost"}],"panels":[]}]},"httpPath":"/api/proxyInfo/add"},{"label":"Modifying proxy information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/proxies/updateproxyusingpost","routeSlug":"/api-reference/shared-resources/shared-api/proxies/updateproxyusingpost","metadata":{"seo":{"title":"Modifying proxy information","description":"Update a proxy configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateProxyUsingPOST","name":"Modifying proxy information","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1proxyInfo~1update/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modifying proxy information","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 proxy configuration."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the proxy must exist in the team. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dynamic proxies cannot be updated"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through this endpoint. The provider must be a recognised value."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": this is a full overwrite, not a patch — fields you omit fall back to their defaults rather than keeping their current values. Read the proxy first and send it back complete."},"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":"Propagation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": profiles keep their binding because only the proxy record changes, but a browser or Cloud Phone that is already running continues to use the connection details it started with. Restart it to pick up the new ones."},"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":"Completion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": synchronous. No optimistic locking, so concurrent updates are last-write-wins."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documented business errors: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14003"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/getting-started/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for what each code means. Any operation can additionally return the common codes."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2541","exampleIds":["paths/~1api~1proxyInfo~1update/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2541","exampleIds":["paths/~1api~1proxyInfo~1update/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1proxyInfo~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proxyInfo/update","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2541","exampleIds":["paths/~1api~1proxyInfo~1update/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/proxyInfo/update","href":"proxies/updateproxyusingpost","openApiOperationId":"updateProxyUsingPOST","summary":"Modifying proxy information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2541","exampleIds":["paths/~1api~1proxyInfo~1update/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2541","exampleIds":["paths/~1api~1proxyInfo~1update/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. This operation returns no payload; the outcome is carried by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2542","exampleIds":["paths/~1api~1proxyInfo~1update/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2542","exampleIds":["paths/~1api~1proxyInfo~1update/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1proxyInfo~1update/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2542","exampleIds":["paths/~1api~1proxyInfo~1update/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2542","exampleIds":["paths/~1api~1proxyInfo~1update/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proxies/updateproxyusingpost"}],"panels":[]}]},"httpPath":"/api/proxyInfo/update"},{"label":"Delete proxy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/proxies/deleteproxyusingpost","routeSlug":"/api-reference/shared-resources/shared-api/proxies/deleteproxyusingpost","metadata":{"seo":{"title":"Delete proxy","description":"Delete one or more proxy configurations."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteProxyUsingPOST","name":"Delete proxy","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1proxyInfo~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete proxy","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 one or more proxy configurations."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": at least one id must resolve within the team; ids that do not are ignored silently. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An unexpired cloud-platform proxy cannot be deleted"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and is reported with a dedicated error."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": own proxies are removed and unbound from any jump server. An expired cloud-platform proxy is instead marked for release, its subscription is cancelled, and the IP is released "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"asynchronously"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — the release may still be in flight when the response returns."},"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":"Cascade"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": profiles and Cloud Phones bound to the proxy are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"neither blocked nor unbound"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". They keep pointing at the deleted proxy, and running sessions are not interrupted. Rebind them with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/env/setProxy/batch"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before deleting."},"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":"Retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ids are processed one at a time and the call aborts on the first rejection, so a batch can be partially applied. Re-read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/proxyInfo/page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before retrying."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documented business errors: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14017"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14024"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/getting-started/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for what each code means. Any operation can additionally return the common codes."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2543","exampleIds":["paths/~1api~1proxyInfo~1delete/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2543","exampleIds":["paths/~1api~1proxyInfo~1delete/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1proxyInfo~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/proxyInfo/delete","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2543","exampleIds":["paths/~1api~1proxyInfo~1delete/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/proxyInfo/delete","href":"proxies/deleteproxyusingpost","openApiOperationId":"deleteProxyUsingPOST","summary":"Delete proxy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2543","exampleIds":["paths/~1api~1proxyInfo~1delete/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2543","exampleIds":["paths/~1api~1proxyInfo~1delete/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. This operation returns no payload; the outcome is carried by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2542","exampleIds":["paths/~1api~1proxyInfo~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2542","exampleIds":["paths/~1api~1proxyInfo~1delete/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1proxyInfo~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2542","exampleIds":["paths/~1api~1proxyInfo~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2542","exampleIds":["paths/~1api~1proxyInfo~1delete/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proxies/deleteproxyusingpost"}],"panels":[]}]},"httpPath":"/api/proxyInfo/delete"}],"content":{"contentType":"group","meta":{"name":"Proxies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proxies","showPageActions":true},{"nodeType":"markdoc","content":"APIs for Proxies."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/proxyInfo/page","summary":"Getting a list of proxies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proxies/queryproxyinfopageusingpost","deprecated":false},{"title":"/api/proxyInfo/add","summary":"Adding proxy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proxies/addusingpost","deprecated":false},{"title":"/api/proxyInfo/update","summary":"Modifying proxy information","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proxies/updateproxyusingpost","deprecated":false},{"title":"/api/proxyInfo/delete","summary":"Delete proxy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proxies/deleteproxyusingpost","deprecated":false}]}]}]}]}},{"type":"group","label":"Groups","link":"/api-reference/shared-resources/shared-api/groups","routeSlug":"/api-reference/shared-resources/shared-api/groups","items":[{"label":"Get a list of groups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/groups/apienvgrouppagepost","routeSlug":"/api-reference/shared-resources/shared-api/groups/apienvgrouppagepost","metadata":{"seo":{"title":"Get a list of groups","description":"List profile groups, page by page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apiEnvgroupPagePost","name":"Get a list of groups","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1envgroup~1page/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get a list of groups","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 profile groups, page by page."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": none. Read-only. Safe to retry with bounded backoff."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": when the team authorizes access per group, a member who has no group grants receives an empty page rather than an error."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2544","exampleIds":["paths/~1api~1envgroup~1page/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2544","exampleIds":["paths/~1api~1envgroup~1page/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1envgroup~1page/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/envgroup/page","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2544","exampleIds":["paths/~1api~1envgroup~1page/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/envgroup/page","href":"groups/apienvgrouppagepost","openApiOperationId":"apiEnvgroupPagePost","summary":"Get a list of groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2544","exampleIds":["paths/~1api~1envgroup~1page/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2544","exampleIds":["paths/~1api~1envgroup~1page/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.dataList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds the records for the requested page and is an empty array when there are no matches; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.current"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" describe the paging."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2545","exampleIds":["paths/~1api~1envgroup~1page/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2545","exampleIds":["paths/~1api~1envgroup~1page/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1envgroup~1page/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2545","exampleIds":["paths/~1api~1envgroup~1page/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2545","exampleIds":["paths/~1api~1envgroup~1page/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/apienvgrouppagepost"}],"panels":[]}]},"httpPath":"/api/envgroup/page"},{"label":"Modify grouping information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/groups/apienvgroupeditpost","routeSlug":"/api-reference/shared-resources/shared-api/groups/apienvgroupeditpost","metadata":{"seo":{"title":"Modify grouping information","description":"Rename a profile group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apiEnvgroupEditPost","name":"Modify grouping information","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1envgroup~1edit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify grouping information","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rename a profile group."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the group must exist in the team, the caller must be authorized for it, and the new name must not collide with another group. The uniqueness check only runs when the name actually changes."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": renames the group. Profiles stay in it — they reference the group by id, so nothing else has to be updated."},"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":"Completion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": synchronous and idempotent."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2546","exampleIds":["paths/~1api~1envgroup~1edit/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2546","exampleIds":["paths/~1api~1envgroup~1edit/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1envgroup~1edit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/envgroup/edit","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2546","exampleIds":["paths/~1api~1envgroup~1edit/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/envgroup/edit","href":"groups/apienvgroupeditpost","openApiOperationId":"apiEnvgroupEditPost","summary":"Modify grouping information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2546","exampleIds":["paths/~1api~1envgroup~1edit/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2546","exampleIds":["paths/~1api~1envgroup~1edit/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a single boolean value."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2547","exampleIds":["paths/~1api~1envgroup~1edit/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2547","exampleIds":["paths/~1api~1envgroup~1edit/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1envgroup~1edit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2547","exampleIds":["paths/~1api~1envgroup~1edit/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2547","exampleIds":["paths/~1api~1envgroup~1edit/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/apienvgroupeditpost"}],"panels":[]}]},"httpPath":"/api/envgroup/edit"},{"label":"Add group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/groups/apienvgroupcreatepost","routeSlug":"/api-reference/shared-resources/shared-api/groups/apienvgroupcreatepost","metadata":{"seo":{"title":"Add group","description":"Create a profile group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apiEnvgroupCreatePost","name":"Add group","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1envgroup~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add group","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a profile group."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the name must be non-empty, at most 100 characters, and not already used by a group in the team. "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A team is limited to 1000 groups."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": creates the group. When the team authorizes access per group and the caller is not the owner, the caller is also granted access to the new group."},"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":"Completion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": synchronous; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" carries the new group id."},"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":"Retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a duplicate name is rejected rather than reusing the existing group, so a retry after a successful-but-unseen call fails with a duplicate-name error — that is a signal the first call worked. Confirm with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/envgroup/page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2548","exampleIds":["paths/~1api~1envgroup~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2548","exampleIds":["paths/~1api~1envgroup~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1envgroup~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/envgroup/create","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2548","exampleIds":["paths/~1api~1envgroup~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/envgroup/create","href":"groups/apienvgroupcreatepost","openApiOperationId":"apiEnvgroupCreatePost","summary":"Add group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2548","exampleIds":["paths/~1api~1envgroup~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2548","exampleIds":["paths/~1api~1envgroup~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an object with the fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groupName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2549","exampleIds":["paths/~1api~1envgroup~1create/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2549","exampleIds":["paths/~1api~1envgroup~1create/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1envgroup~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2549","exampleIds":["paths/~1api~1envgroup~1create/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2549","exampleIds":["paths/~1api~1envgroup~1create/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/apienvgroupcreatepost"}],"panels":[]}]},"httpPath":"/api/envgroup/create"},{"label":"Delete group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/groups/apienvgroupdeletepost","routeSlug":"/api-reference/shared-resources/shared-api/groups/apienvgroupdeletepost","metadata":{"seo":{"title":"Delete group","description":"Delete one or more profile groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apiEnvgroupDeletePost","name":"Delete group","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1envgroup~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete group","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 one or more profile groups."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": at least one id must resolve within the team and the caller must be authorized for it; ids that do not resolve are ignored silently."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": deletes the groups and their member access grants. Browser profiles and Cloud Phones that were in them become ungrouped, so no dangling group reference is left behind. Setting the delete-environments flag additionally moves the profiles you are authorized for "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"into the recycle bin"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" — they are not destroyed and Cloud Phones are never affected by that flag."},"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":"Completion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": synchronous but "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not atomic"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The group is deleted first and the follow-up steps can still fail, for example when a profile is running or mid-transfer, leaving the group gone and the profiles unmoved."},"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":"Retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": verify with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/envgroup/page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the profile list before retrying."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documented business errors: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"19064"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/getting-started/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for what each code means. Any operation can additionally return the common codes."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2550","exampleIds":["paths/~1api~1envgroup~1delete/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2550","exampleIds":["paths/~1api~1envgroup~1delete/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1envgroup~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/envgroup/delete","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2550","exampleIds":["paths/~1api~1envgroup~1delete/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/envgroup/delete","href":"groups/apienvgroupdeletepost","openApiOperationId":"apiEnvgroupDeletePost","summary":"Delete group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2550","exampleIds":["paths/~1api~1envgroup~1delete/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2550","exampleIds":["paths/~1api~1envgroup~1delete/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a single boolean value."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2551","exampleIds":["paths/~1api~1envgroup~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2551","exampleIds":["paths/~1api~1envgroup~1delete/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1envgroup~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2551","exampleIds":["paths/~1api~1envgroup~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2551","exampleIds":["paths/~1api~1envgroup~1delete/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/groups/apienvgroupdeletepost"}],"panels":[]}]},"httpPath":"/api/envgroup/delete"}],"content":{"contentType":"group","meta":{"name":"Groups"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Groups","showPageActions":true},{"nodeType":"markdoc","content":"APIs for Groups."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/envgroup/page","summary":"Get a list of groups","prefix":{"name":"post","color":"post"},"badges":[],"link":"/groups/apienvgrouppagepost","deprecated":false},{"title":"/api/envgroup/edit","summary":"Modify grouping information","prefix":{"name":"post","color":"post"},"badges":[],"link":"/groups/apienvgroupeditpost","deprecated":false},{"title":"/api/envgroup/create","summary":"Add group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/groups/apienvgroupcreatepost","deprecated":false},{"title":"/api/envgroup/delete","summary":"Delete group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/groups/apienvgroupdeletepost","deprecated":false}]}]}]}]}},{"type":"group","label":"Tags","link":"/api-reference/shared-resources/shared-api/tags","routeSlug":"/api-reference/shared-resources/shared-api/tags","items":[{"label":"Getting a list of tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/tags/apienvtagallget","routeSlug":"/api-reference/shared-resources/shared-api/tags/apienvtagallget","metadata":{"seo":{"title":"Getting a list of tags","description":"Return every profile tag in the team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apiEnvtagAllGet","name":"Getting a list of tags","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1envtag~1all/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Getting a list of tags","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Return every profile tag in the team."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": none. Read-only. Safe to retry with bounded backoff."},"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":"Note"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": this endpoint is "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"not paginated and tags have no server-side limit"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", so the response grows with the number of tags your team has created. Size your client accordingly."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/envtag/all","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200"],"pointer":"/api/envtag/all","href":"tags/apienvtagallget","openApiOperationId":"apiEnvtagAllGet","summary":"Getting a list of tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an array of objects with the fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and an empty array when there is nothing to return."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2552","exampleIds":["paths/~1api~1envtag~1all/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_2552","exampleIds":["paths/~1api~1envtag~1all/get/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1envtag~1all/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2552","exampleIds":["paths/~1api~1envtag~1all/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2552","exampleIds":["paths/~1api~1envtag~1all/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/apienvtagallget"}],"panels":[]}]},"httpPath":"/api/envtag/all"},{"label":"Create tags","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/tags/apienvtagcreatepost","routeSlug":"/api-reference/shared-resources/shared-api/tags/apienvtagcreatepost","metadata":{"seo":{"title":"Create tags","description":"Create a profile tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apiEnvtagCreatePost","name":"Create tags","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1envtag~1create/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create tags","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a profile tag."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the name must be non-empty, at most 100 characters, and not already used by a tag in the team."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": creates the tag and returns its id. Unlike groups, tags have no count limit."},"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":"Retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": a duplicate name is rejected rather than reusing the existing tag. Confirm with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/envtag/all"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2553","exampleIds":["paths/~1api~1envtag~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2553","exampleIds":["paths/~1api~1envtag~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1envtag~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/envtag/create","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2553","exampleIds":["paths/~1api~1envtag~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/envtag/create","href":"tags/apienvtagcreatepost","openApiOperationId":"apiEnvtagCreatePost","summary":"Create tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2553","exampleIds":["paths/~1api~1envtag~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2553","exampleIds":["paths/~1api~1envtag~1create/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an object with the fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"tagName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2554","exampleIds":["paths/~1api~1envtag~1create/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2554","exampleIds":["paths/~1api~1envtag~1create/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1envtag~1create/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2554","exampleIds":["paths/~1api~1envtag~1create/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2554","exampleIds":["paths/~1api~1envtag~1create/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/apienvtagcreatepost"}],"panels":[]}]},"httpPath":"/api/envtag/create"},{"label":"Modify information of tags","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/tags/apienvtageditpost","routeSlug":"/api-reference/shared-resources/shared-api/tags/apienvtageditpost","metadata":{"seo":{"title":"Modify information of tags","description":"Rename a profile tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apiEnvtagEditPost","name":"Modify information of tags","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1envtag~1edit/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Modify information of tags","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rename a profile tag."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": the tag must exist in the team, and the new name must not collide with another tag."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": renames the tag. Existing tag assignments are unaffected and profiles show the new name immediately."},"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":"Completion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": synchronous and idempotent."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2555","exampleIds":["paths/~1api~1envtag~1edit/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2555","exampleIds":["paths/~1api~1envtag~1edit/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1envtag~1edit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/envtag/edit","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2555","exampleIds":["paths/~1api~1envtag~1edit/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/envtag/edit","href":"tags/apienvtageditpost","openApiOperationId":"apiEnvtagEditPost","summary":"Modify information of tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2555","exampleIds":["paths/~1api~1envtag~1edit/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2555","exampleIds":["paths/~1api~1envtag~1edit/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a single boolean value."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2556","exampleIds":["paths/~1api~1envtag~1edit/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2556","exampleIds":["paths/~1api~1envtag~1edit/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1envtag~1edit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2556","exampleIds":["paths/~1api~1envtag~1edit/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2556","exampleIds":["paths/~1api~1envtag~1edit/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/apienvtageditpost"}],"panels":[]}]},"httpPath":"/api/envtag/edit"},{"label":"Delete tags","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/tags/apienvtagdeletepost","routeSlug":"/api-reference/shared-resources/shared-api/tags/apienvtagdeletepost","metadata":{"seo":{"title":"Delete tags","description":"Delete one or more profile tags."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apiEnvtagDeletePost","name":"Delete tags","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1envtag~1delete/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete tags","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"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 one or more profile tags."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": at least one id must resolve within the team; ids that do not are ignored silently."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": deletes the tags. The tag disappears from every profile that carried it, and no profile is deleted. This endpoint only manages profile tags — Cloud Storage file tags are managed separately."},"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":"Completion"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": synchronous. A repeat call reports the tags as invalid, which means the first one succeeded."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documented business errors: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"19105"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/getting-started/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for what each code means. Any operation can additionally return the common codes."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2557","exampleIds":["paths/~1api~1envtag~1delete/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2557","exampleIds":["paths/~1api~1envtag~1delete/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1envtag~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/envtag/delete","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2557","exampleIds":["paths/~1api~1envtag~1delete/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/envtag/delete","href":"tags/apienvtagdeletepost","openApiOperationId":"apiEnvtagDeletePost","summary":"Delete tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2557","exampleIds":["paths/~1api~1envtag~1delete/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2557","exampleIds":["paths/~1api~1envtag~1delete/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is a single boolean value."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2551","exampleIds":["paths/~1api~1envtag~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2551","exampleIds":["paths/~1api~1envtag~1delete/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1envtag~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2551","exampleIds":["paths/~1api~1envtag~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2551","exampleIds":["paths/~1api~1envtag~1delete/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tags/apienvtagdeletepost"}],"panels":[]}]},"httpPath":"/api/envtag/delete"}],"content":{"contentType":"group","meta":{"name":"Tags"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tags","showPageActions":true},{"nodeType":"markdoc","content":"APIs for Tags."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/envtag/all","summary":"Getting a list of tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tags/apienvtagallget","deprecated":false},{"title":"/api/envtag/create","summary":"Create tags","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/apienvtagcreatepost","deprecated":false},{"title":"/api/envtag/edit","summary":"Modify information of tags","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/apienvtageditpost","deprecated":false},{"title":"/api/envtag/delete","summary":"Delete tags","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tags/apienvtagdeletepost","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhooks","link":"/api-reference/shared-resources/shared-api/webhooks","routeSlug":"/api-reference/shared-resources/shared-api/webhooks","items":[{"label":"Configure the team webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/shared-api/webhooks/apiwebhookconfigpost","routeSlug":"/api-reference/shared-resources/shared-api/webhooks/apiwebhookconfigpost","metadata":{"seo":{"title":"Configure the team webhook","description":"Create or replace the team's webhook configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"apiWebhookConfigPost","name":"Configure the team webhook","deprecated":false,"isWebhook":false,"pointer":"/paths/~1api~1webhook~1config/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure the team webhook","isWebhook":false,"deprecated":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create or replace the team's webhook configuration."},"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":"Preconditions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callbackUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be an HTTPS URL of 1 to 1024 characters, with a host, no user info, no fragment and a valid port. Every address it resolves to must be publicly routable; localhost, private, link-local, CGNAT, cloud metadata, protocol-reserved, documentation and 6to4 ranges are rejected. The same check runs again when a delivery opens its connection, so a name that later resolves into a private range fails that delivery instead of reaching your network."},"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":"Effect"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": upserts the single configuration owned by the team in the server-side context. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teamId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is never read from the request, so a caller cannot configure another team. The Local API and Open API endpoints read and write the same record, and the response echoes what was stored."},"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":"Disabling"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keeps the URL and stops new events from being created. Events already queued are cancelled one by one if the configuration is still disabled when they are next authorized, so re-enabling quickly lets them continue."},"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":"Retry"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": safe. The save is an upsert keyed by team, so repeating the same request converges on the same state."},"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":"Client version"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": requires MoreLogin client v2.66.0 or higher, because the desktop client is what exposes this route locally. The Open API endpoint has no client dependency."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/getting-started/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the callback contract, event names and retry schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documented business errors: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"41001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/getting-started/error-codes"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error Codes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for what each code means. Any operation can additionally return the common codes."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2558","exampleIds":["paths/~1api~1webhook~1config/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2558","exampleIds":["paths/~1api~1webhook~1config/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1api~1webhook~1config/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/webhook/config","servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_2558","exampleIds":["paths/~1api~1webhook~1config/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/api/webhook/config","href":"webhooks/apiwebhookconfigpost","openApiOperationId":"apiWebhookConfigPost","summary":"Configure the team webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}],"schemaId":"schema_2558","exampleIds":["paths/~1api~1webhook~1config/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2558","exampleIds":["paths/~1api~1webhook~1config/post/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Success. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is an object with the fields "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"callbackUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", echoing the stored configuration."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2559","exampleIds":["paths/~1api~1webhook~1config/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_2559","exampleIds":["paths/~1api~1webhook~1config/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1api~1webhook~1config/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2559","exampleIds":["paths/~1api~1webhook~1config/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2559","exampleIds":["paths/~1api~1webhook~1config/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhooks/apiwebhookconfigpost"}],"panels":[]}]},"httpPath":"/api/webhook/config"}],"content":{"contentType":"group","meta":{"name":"Webhooks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhooks","showPageActions":true},{"nodeType":"markdoc","content":"APIs for the team webhook configuration."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/webhook/config","summary":"Configure the team webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhooks/apiwebhookconfigpost","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"schema_2537":{"kind":"json-schema","data":{"type":"object","properties":{"pageNo":{"type":"integer","description":"Current page number (starts from 1)","example":1},"pageSize":{"type":"integer","description":"Number of items per page","example":10},"isCloudPhoneProxy":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the proxy is for cloud phone usage."},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Exclude local/private IPs (e.g., 127.0.0.1, 360, pia, private ranges)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Return all proxies"},"children":[]}]}]}]}],"example":false},"proxyCategoryType":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy category type:"},"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":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Cloud platform"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Self-owned IP"},"children":[]}]}]}]}],"example":2},"proxyIp":{"type":"string","description":"Filter by proxy IP address (partial match)","example":""},"proxyName":{"type":"string","description":"Filter by proxy name (partial match)","example":""},"proxyProviders":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of proxy provider IDs. Supported values:"},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = HTTP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = HTTPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = SOCKS5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = SSH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Oxylabs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Proxys.io"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = GeoSurf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Luminati"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Lumauto"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Oxylabsauto"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Trojan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Shadowsocks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = vmess"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = ABCPROXY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = LunaProxy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = IPHTML"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = PiaProxy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"17"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 922S5"},"children":[]}]}]}]}],"example":[]},"proxyStatus":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy assignment status:"},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Normal"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Unassigned"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Upgrading"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Expired"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Expiring soon"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: Self-owned proxies always use status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"example":1},"proxyCheckStatus":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy health check status:"},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Pending"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Success"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Failed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Unknown error"},"children":[]}]}]}]}],"example":1},"proxyTypes":{"type":"array","items":{"type":"integer"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy protocol types:"},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = HTTP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = HTTPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = SOCKS5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = SSH"},"children":[]}]}]}]}],"example":[]}},"required":[]},"id":"schema_2537"},"schema_2538":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"Error message","type":["string","null"]},"data":{"type":"object","properties":{"current":{"type":"string"},"dataList":{"type":"array","items":{"type":"object","properties":{"expiryTime":{"description":"Expiration time","type":"string"},"id":{"description":"Primary key","type":"string"},"proxyCategoryType":{"description":"Proxy type 1:Platform proxy; 2:Self-owned proxy","type":"integer"},"proxyCheckStatus":{"description":"Detection status 0-pending detection 1-monitoring success 2-detection failure 3-unknown error","type":"integer"},"proxyIp":{"description":"Proxy IP","type":"string"},"exportIp":{"description":"export IP","type":"string"},"countryCode":{"description":"countryCode","type":"string"},"proxyName":{"description":"Proxy Name","type":"string"},"proxyProvider":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy Provider:default value 0-HTTP 1-HTTPS 2-SOCKS5 3-SSH 4-Oxylabs 5-Proxys.io 7-Luminati 8-Lumauto 9-Oxylabsauto 10-Trojan，11-Shadowsocks 13-ABCPROXY 14-LunaProxy 15-IPHTML 16-PiaProxy 17-922S5"},"children":[]}]}]}],"type":"integer"},"proxyType":{"description":"Proxy Type:0-http 1-https 2-socks5 3-ssh","type":"integer"},"username":{"description":"Proxy username","type":"string"},"password":{"description":"Proxy password","type":"string"},"refreshUrl":{"description":"Proxy refresh URL","type":"string"}}}},"pages":{"type":"string"},"total":{"type":"string"}},"required":["current","dataList","pages","total"]},"requestId":{"description":"Operation Request ID","type":"string"}},"required":["code","msg","data","requestId"]},"id":"schema_2538"},"schema_2539":{"kind":"json-schema","data":{"type":"object","properties":{"city":{"type":"string","description":"City","example":""},"country":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Country code (ISO 3166-1 alpha-2). Required only if proxyProvider=17."},"children":[]}]}]}],"example":"AD"},"encryptionType":{"type":"integer","format":"int32","description":"Encryption type, valid values are integers from 1 to 14.","example":14},"ipChangeAction":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action on IP change:0 = Block, 1 = Warn"},"children":[]}]}]}],"example":1},"ipMonitor":{"type":"boolean","description":"Enable IP change monitoring","example":false},"password":{"type":"string","description":"Password for proxy authentication","example":""},"proxyIp":{"type":"string","description":"Proxy IP address","example":"8.10.22.46"},"proxyName":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy name (supports placeholders like {{random}})"},"children":[]}]}]}],"example":"sock5_{{random}}"},"proxyPort":{"type":"integer","format":"int32","description":"Proxy port number","example":65534},"proxyProvider":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy provider type:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH, 4=Oxylabs, 5=Proxys.io, 6=GeoSurf, 7=Luminati, 8=Lumauto, 9=Oxylabsauto, 10=Trojan, 11=Shadowsocks, 12=vmess, 13=ABCPROXY, 14=LunaProxy, 15=IPHTML, 16=PiaProxy, 17=922S5."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special rules:"},"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":"If proxyProvider is 7 or 8, proxyType is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If proxyProvider is 17, country is required; state and city are optional."},"children":[]}]}]}]}],"example":2},"proxyType":{"type":"integer","format":"int32","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy protocol type: 0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required only when proxyProvider is 7 or 8."},"children":[]}]}]}],"example":1},"refreshUrl":{"type":"string","description":"URL to refresh dynamic proxy IP (if supported)","example":""},"state":{"type":"string","description":"State/Province","example":""},"username":{"type":"string","description":"Username for proxy authentication","example":""}},"required":["proxyIp","proxyPort","proxyProvider"]},"id":"schema_2539"},"schema_2540":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"Error message","type":["string","null"]},"data":{"description":"Proxy ID","type":"integer"},"requestId":{"description":"Operation Request ID","type":"string"}},"required":["code","msg","data","requestId"]},"id":"schema_2540"},"schema_2541":{"kind":"json-schema","data":{"type":"object","required":["id","proxyIp","proxyPort","proxyProvider"],"properties":{"id":{"type":"string","description":"Unique proxy ID"},"proxyIp":{"type":"string","description":"Proxy server IP address"},"proxyPort":{"type":"integer","description":"Proxy server port"},"proxyName":{"type":"string","description":"Custom name for the proxy"},"country":{"type":"string","description":"Country (e.g., \"US\", \"CN\")"},"city":{"type":"string","description":"City name"},"username":{"type":"string","description":"Authentication username (if required)"},"password":{"type":"string","description":"Authentication password (if required)"},"proxyType":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy protocol type:"},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = HTTP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = HTTPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = SOCKS5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = SSH"},"children":[]}]}]}]}]},"proxyProvider":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proxy provider ID:"},"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":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = HTTP"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = HTTPS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = SOCKS5"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = SSH"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"4"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Oxylabs"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Proxys.io"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"6"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = GeoSurf"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"7"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Luminati"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"8"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Lumauto"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Oxylabsauto"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Trojan"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"11"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Shadowsocks"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"12"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = vmess"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"13"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = ABCPROXY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"14"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = LunaProxy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"15"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = IPHTML"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"16"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = PiaProxy"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"17"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = 922S5"},"children":[]}]}]}]}]},"encryptionType":{"type":"integer","description":"Encryption type (provider-specific, usually 0 for plain)"},"ipMonitor":{"type":"boolean","description":"Enable IP change monitoring"},"ipChangeAction":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Action to take when IP changes:"},"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":"1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" = Notify / Refresh (common value)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Check system documentation for full options."},"children":[]}]}]}]}]},"refreshUrl":{"type":"string","description":"URL to trigger IP refresh (if supported by provider)"},"state":{"type":"string","description":"Reserved field or custom state (optional)"}}},"id":"schema_2541"},"schema_2542":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"Error message","type":["string","null"]},"requestId":{"description":"Operation Request ID","type":"string"}},"required":["code","msg","requestId"]},"id":"schema_2542"},"schema_2543":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int64"}},"id":"schema_2543"},"schema_2544":{"kind":"json-schema","data":{"type":"object","properties":{"groupName":{"type":"string","title":"Group name (partial match)"},"pageNo":{"type":"integer","title":"Current page"},"pageSize":{"type":"integer","title":"Items per page"}},"required":["groupName","pageNo","pageSize"]},"id":"schema_2544"},"schema_2545":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"Error message","type":["string","null"]},"data":{"type":"object","properties":{"current":{"type":"string"},"dataList":{"type":"array","items":{"type":"object","properties":{"id":{"description":"Group ID","type":"string"},"groupName":{"description":"Group name","type":"string"}}}},"pages":{"type":"string"},"total":{"type":"string"}},"required":["current","dataList","pages","total"]},"requestId":{"description":"Operation Request ID","type":"string"}},"required":["code","msg","data","requestId"]},"id":"schema_2545"},"schema_2546":{"kind":"json-schema","data":{"type":"object","required":["groupName","id"],"properties":{"groupName":{"type":"string","description":"New name for the environment group"},"id":{"type":"string","description":"Unique ID of the group to be updated"}}},"id":"schema_2546"},"schema_2547":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"Error message","type":["string","null"]},"data":{"type":"boolean","description":"result"},"requestId":{"description":"Operation Request ID","type":"string"}},"required":["code","msg","data","requestId"]},"id":"schema_2547"},"schema_2548":{"kind":"json-schema","data":{"type":"object","required":["groupName"],"properties":{"groupName":{"description":"Name of group","type":"string"}}},"id":"schema_2548"},"schema_2549":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"Error message","type":["string","null"]},"data":{"description":"The data returned by the operation","type":"object","properties":{"id":{"description":"ID of group","type":"string"},"groupName":{"description":"Name of group","type":"string"}}},"requestId":{"description":"Operation Request ID","type":"string"}},"required":["code","msg","data","requestId"]},"id":"schema_2549"},"schema_2550":{"kind":"json-schema","data":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Unique ID of the group to be updated"},"isDeleteAllEnv":{"type":"boolean","description":"Delete environments in the group? false:Do not delete true:Delete"}}},"id":"schema_2550"},"schema_2551":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"Error message","type":["string","null"]},"data":{"type":"boolean"},"requestId":{"description":"Operation Request ID","type":"string"}},"required":["code","msg","data","requestId"]},"id":"schema_2551"},"schema_2552":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"error message","type":["string","null"]},"data":{"type":"array","items":{"type":"object","properties":{"id":{"description":"ID of tags","type":"string"},"tagName":{"description":"Name of tags","type":"string"}}}},"requestId":{"description":"Operation Request ID","type":"string"}},"required":["code","msg","data","requestId"]},"id":"schema_2552"},"schema_2553":{"kind":"json-schema","data":{"type":"object","required":["tagName"],"properties":{"tagName":{"type":"string","description":"tag name"}}},"id":"schema_2553"},"schema_2554":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"error message","type":["string","null"]},"data":{"type":"object","properties":{"id":{"description":"ID of tags","type":"string"},"tagName":{"description":"Name of tags","type":"string"}},"required":["id","tagName"]},"requestId":{"description":"Operation Request ID","type":"string"},"error":{"type":"object","properties":{}}},"required":["code","msg","data","requestId"]},"id":"schema_2554"},"schema_2555":{"kind":"json-schema","data":{"type":"object","required":["id","tagName"],"properties":{"id":{"type":"string","description":"tag id"},"tagName":{"type":"string","description":"tag name"}}},"id":"schema_2555"},"schema_2556":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"Error message","type":["string","null"]},"data":{"type":"boolean"},"requestId":{"description":"Operation Request ID","type":"string"},"error":{"type":"object","properties":{}}},"required":["code","msg","data","requestId"]},"id":"schema_2556"},"schema_2557":{"kind":"json-schema","data":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"string"},"description":"Unique ID of the tag to be updated"}}},"id":"schema_2557"},"schema_2558":{"kind":"json-schema","data":{"type":"object","properties":{"callbackUrl":{"description":"HTTPS URL that receives the events. 1 to 1024 characters.","type":"string","maxLength":1024},"enabled":{"description":"Whether delivery is enabled for the team.","type":"boolean"}},"required":["callbackUrl","enabled"]},"id":"schema_2558"},"schema_2559":{"kind":"json-schema","data":{"type":"object","properties":{"code":{"description":"Return result code 0:Normal Other codes are exceptions.","type":"integer"},"msg":{"description":"error message","type":["string","null"]},"data":{"type":"object","properties":{"callbackUrl":{"description":"The stored HTTPS callback URL.","type":"string"},"enabled":{"description":"Whether delivery is enabled for the team.","type":"boolean"}}},"requestId":{"description":"Operation Request ID","type":"string"}},"required":["code","msg","data","requestId"]},"id":"schema_2559"}},"exampleStore":{"paths/~1api~1proxyInfo~1page/post/requestBody/content/application~1json/example":{"value":{"pageNo":1,"pageSize":10,"isCloudPhoneProxy":false,"proxyCategoryType":2,"proxyIp":"","proxyName":"","proxyProviders":[],"proxyStatus":1,"proxyCheckStatus":1,"proxyTypes":[]},"id":"paths/~1api~1proxyInfo~1page/post/requestBody/content/application~1json/example"},"paths/~1api~1proxyInfo~1page/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":null,"data":{"current":"1","dataList":[{"expiryTime":"2026-09-01 12:00:00","id":"1673823102599682","proxyCategoryType":1,"proxyCheckStatus":1,"proxyIp":"string","exportIp":"9222","countryCode":"string","proxyName":"example-name","proxyProvider":1,"proxyType":1,"username":"example-name","password":"string","refreshUrl":"https://example.com/resource"}],"pages":"1","total":"1"},"requestId":"0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"},"id":"paths/~1api~1proxyInfo~1page/post/responses/200/content/application~1json/example"},"paths/~1api~1proxyInfo~1add/post/requestBody/content/application~1json/example":{"value":{"proxyIp":"8.10.22.46","proxyPort":65534,"proxyProvider":2,"proxyType":1,"country":"AD","state":"","city":"","encryptionType":14,"ipChangeAction":1,"ipMonitor":false,"proxyName":"sock5_{{random}}","refreshUrl":"","username":"","password":""},"id":"paths/~1api~1proxyInfo~1add/post/requestBody/content/application~1json/example"},"paths/~1api~1proxyInfo~1add/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":0,"requestId":"abcd1234"},"id":"paths/~1api~1proxyInfo~1add/post/responses/200/content/application~1json/example"},"paths/~1api~1proxyInfo~1update/post/requestBody/content/application~1json/example":{"value":{"id":"1566403036579198","proxyIp":"108.11.23.85","proxyPort":4096,"proxyName":"MyProxy","country":"US","city":"New York","username":"","password":"","proxyType":0,"proxyProvider":0,"encryptionType":0,"ipMonitor":true,"ipChangeAction":1,"refreshUrl":"","state":""},"id":"paths/~1api~1proxyInfo~1update/post/requestBody/content/application~1json/example"},"paths/~1api~1proxyInfo~1update/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","requestId":"efgh5678"},"id":"paths/~1api~1proxyInfo~1update/post/responses/200/content/application~1json/example"},"paths/~1api~1proxyInfo~1delete/post/requestBody/content/application~1json/example":{"value":[1054661322597744600,1054661322597744600],"id":"paths/~1api~1proxyInfo~1delete/post/requestBody/content/application~1json/example"},"paths/~1api~1proxyInfo~1delete/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","requestId":"ijkl9012"},"id":"paths/~1api~1proxyInfo~1delete/post/responses/200/content/application~1json/example"},"paths/~1api~1envgroup~1page/post/requestBody/content/application~1json/example":{"value":{"groupName":"132-kernel","pageNo":1,"pageSize":10},"id":"paths/~1api~1envgroup~1page/post/requestBody/content/application~1json/example"},"paths/~1api~1envgroup~1page/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":{"current":"0","dataList":[{"id":"0","groupName":""}],"pages":"0","total":"0"},"requestId":""},"id":"paths/~1api~1envgroup~1page/post/responses/200/content/application~1json/example"},"paths/~1api~1envgroup~1edit/post/requestBody/content/application~1json/example":{"value":{"groupName":"Group-1574544945848579","id":"1574525425557584"},"id":"paths/~1api~1envgroup~1edit/post/requestBody/content/application~1json/example"},"paths/~1api~1envgroup~1edit/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":null,"data":true,"requestId":"0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"},"id":"paths/~1api~1envgroup~1edit/post/responses/200/content/application~1json/example"},"paths/~1api~1envgroup~1create/post/requestBody/content/application~1json/example":{"value":{"groupName":"Group-333"},"id":"paths/~1api~1envgroup~1create/post/requestBody/content/application~1json/example"},"paths/~1api~1envgroup~1create/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":null,"data":{"id":"1673823102599682","groupName":"example-name"},"requestId":"0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"},"id":"paths/~1api~1envgroup~1create/post/responses/200/content/application~1json/example"},"paths/~1api~1envgroup~1delete/post/requestBody/content/application~1json/example":{"value":{"ids":["string"]},"id":"paths/~1api~1envgroup~1delete/post/requestBody/content/application~1json/example"},"paths/~1api~1envgroup~1delete/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":true,"requestId":""},"id":"paths/~1api~1envgroup~1delete/post/responses/200/content/application~1json/example"},"paths/~1api~1envtag~1all/get/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":[{"id":"0","tagName":""}],"requestId":""},"id":"paths/~1api~1envtag~1all/get/responses/200/content/application~1json/example"},"paths/~1api~1envtag~1create/post/requestBody/content/application~1json/example":{"value":{"tagName":"Tag-123"},"id":"paths/~1api~1envtag~1create/post/requestBody/content/application~1json/example"},"paths/~1api~1envtag~1create/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":{"id":"0","tagName":""},"requestId":""},"id":"paths/~1api~1envtag~1create/post/responses/200/content/application~1json/example"},"paths/~1api~1envtag~1edit/post/requestBody/content/application~1json/example":{"value":{"id":"1564715845550177","tagName":"Updated-123"},"id":"paths/~1api~1envtag~1edit/post/requestBody/content/application~1json/example"},"paths/~1api~1envtag~1edit/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":true,"requestId":""},"id":"paths/~1api~1envtag~1edit/post/responses/200/content/application~1json/example"},"paths/~1api~1envtag~1delete/post/requestBody/content/application~1json/example":{"value":{"ids":["string"]},"id":"paths/~1api~1envtag~1delete/post/requestBody/content/application~1json/example"},"paths/~1api~1envtag~1delete/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":true,"requestId":""},"id":"paths/~1api~1envtag~1delete/post/responses/200/content/application~1json/example"},"paths/~1api~1webhook~1config/post/requestBody/content/application~1json/example":{"value":{"callbackUrl":"https://example.com/morelogin/webhook","enabled":true},"id":"paths/~1api~1webhook~1config/post/requestBody/content/application~1json/example"},"paths/~1api~1webhook~1config/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":{"callbackUrl":"https://example.com/morelogin/webhook","enabled":true},"requestId":""},"id":"paths/~1api~1webhook~1config/post/responses/200/content/application~1json/example"}},"securitySchemeStore":{},"servers":[{"url":"http://127.0.0.1:40000","description":"MoreLogin  Local endpoint"}]},"options":{"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/API Reference/Shared Resources/shared-api.json?download"},{"url":"/_bundle/API Reference/Shared Resources/shared-api.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Shared Resources API","description":"Shared resource management APIs for proxies, groups, and tags. These resources are used by both Browser Profiles and Cloud Phones. Base URL: `http://127.0.0.1:40000`"}},"baseSlug":"/api-reference/shared-resources/shared-api","routesMapping":{}}