{"items":[{"type":"link","label":"Shared Resources Open API","link":"/api-reference/shared-resources/open-api","routeSlug":"/api-reference/shared-resources/open-api","content":{"contentType":"overview","meta":{"name":"Shared Resources Open API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"open-api.json","url":"/_bundle/API Reference/Shared Resources/open-api.json?download"},{"kind":"download","label":"open-api.yaml","url":"/_bundle/API Reference/Shared Resources/open-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":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Shared Resources Open 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":"Manage shared resources (proxies, groups, and tags) through the MoreLogin Open API."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base URL"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.morelogin.com"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication is done via OAuth2 Bearer token. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/api-reference/getting-started/authentication"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for details."},"children":[]}]}]}]}],"sectionId":"/api-reference/shared-resources/open-api"}],"sectionId":"/api-reference/shared-resources/open-api"}]}]}},{"type":"group","label":"Proxy Management","link":"/api-reference/shared-resources/open-api/proxy-management","routeSlug":"/api-reference/shared-resources/open-api/proxy-management","items":[{"label":"Getting a list of proxies","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/proxy-management/queryproxyinfopageusingpost","routeSlug":"/api-reference/shared-resources/open-api/proxy-management/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/~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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1proxyInfo~1page/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_0","exampleIds":["paths/~1proxyInfo~1page/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1proxyInfo~1page/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/proxyInfo/page","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~1proxyInfo~1page/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/proxyInfo/page","href":"proxy-management/queryproxyinfopageusingpost","openApiOperationId":"queryProxyInfoPageUsingPOST","summary":"Getting a list of proxies"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_0","exampleIds":["paths/~1proxyInfo~1page/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_0","exampleIds":["paths/~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_1","exampleIds":["paths/~1proxyInfo~1page/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_1","exampleIds":["paths/~1proxyInfo~1page/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1proxyInfo~1page/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1","exampleIds":["paths/~1proxyInfo~1page/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1","exampleIds":["paths/~1proxyInfo~1page/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proxy-management/queryproxyinfopageusingpost"}],"panels":[]}]},"httpPath":"/proxyInfo/page"},{"label":"Adding proxy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/proxy-management/addusingpost","routeSlug":"/api-reference/shared-resources/open-api/proxy-management/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/~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 proxy type."},"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. This only saves the configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~1proxyInfo~1add/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_2","exampleIds":["paths/~1proxyInfo~1add/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1proxyInfo~1add/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/proxyInfo/add","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~1proxyInfo~1add/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/proxyInfo/add","href":"proxy-management/addusingpost","openApiOperationId":"addUsingPOST","summary":"Adding proxy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_2","exampleIds":["paths/~1proxyInfo~1add/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_2","exampleIds":["paths/~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_3","exampleIds":["paths/~1proxyInfo~1add/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_3","exampleIds":["paths/~1proxyInfo~1add/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1proxyInfo~1add/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_3","exampleIds":["paths/~1proxyInfo~1add/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1proxyInfo~1add/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proxy-management/addusingpost"}],"panels":[]}]},"httpPath":"/proxyInfo/add"},{"label":"Modifying proxy information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/proxy-management/updateproxyusingpost","routeSlug":"/api-reference/shared-resources/open-api/proxy-management/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/~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 proxy type 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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1proxyInfo~1update/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_4","exampleIds":["paths/~1proxyInfo~1update/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1proxyInfo~1update/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/proxyInfo/update","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~1proxyInfo~1update/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/proxyInfo/update","href":"proxy-management/updateproxyusingpost","openApiOperationId":"updateProxyUsingPOST","summary":"Modifying proxy information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_4","exampleIds":["paths/~1proxyInfo~1update/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_4","exampleIds":["paths/~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_5","exampleIds":["paths/~1proxyInfo~1update/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_5","exampleIds":["paths/~1proxyInfo~1update/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1proxyInfo~1update/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","exampleIds":["paths/~1proxyInfo~1update/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1proxyInfo~1update/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proxy-management/updateproxyusingpost"}],"panels":[]}]},"httpPath":"/proxyInfo/update"},{"label":"Delete proxy","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/proxy-management/deleteproxyusingpost","routeSlug":"/api-reference/shared-resources/open-api/proxy-management/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/~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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1proxyInfo~1delete/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_6","exampleIds":["paths/~1proxyInfo~1delete/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1proxyInfo~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/proxyInfo/delete","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~1proxyInfo~1delete/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/proxyInfo/delete","href":"proxy-management/deleteproxyusingpost","openApiOperationId":"deleteProxyUsingPOST","summary":"Delete proxy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_6","exampleIds":["paths/~1proxyInfo~1delete/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_6","exampleIds":["paths/~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_5","exampleIds":["paths/~1proxyInfo~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_5","exampleIds":["paths/~1proxyInfo~1delete/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1proxyInfo~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_5","exampleIds":["paths/~1proxyInfo~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5","exampleIds":["paths/~1proxyInfo~1delete/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/proxy-management/deleteproxyusingpost"}],"panels":[]}]},"httpPath":"/proxyInfo/delete"}],"content":{"contentType":"group","meta":{"name":"Proxy Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Proxy Management","showPageActions":true},{"nodeType":"markdoc","content":"Create, update, delete, and list proxy configurations"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/proxyInfo/page","summary":"Getting a list of proxies","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proxy-management/queryproxyinfopageusingpost","deprecated":false},{"title":"/proxyInfo/add","summary":"Adding proxy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proxy-management/addusingpost","deprecated":false},{"title":"/proxyInfo/update","summary":"Modifying proxy information","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proxy-management/updateproxyusingpost","deprecated":false},{"title":"/proxyInfo/delete","summary":"Delete proxy","prefix":{"name":"post","color":"post"},"badges":[],"link":"/proxy-management/deleteproxyusingpost","deprecated":false}]}]}]}]}},{"type":"group","label":"Group Management","link":"/api-reference/shared-resources/open-api/group-management","routeSlug":"/api-reference/shared-resources/open-api/group-management","items":[{"label":"Get a list of groups","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/group-management/envgrouppagepost","routeSlug":"/api-reference/shared-resources/open-api/group-management/envgrouppagepost","metadata":{"seo":{"title":"Get a list of groups","description":"List profile groups, page by page."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"envgroupPagePost","name":"Get a list of groups","deprecated":false,"isWebhook":false,"pointer":"/paths/~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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1envgroup~1page/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_7","exampleIds":["paths/~1envgroup~1page/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1envgroup~1page/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/envgroup/page","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~1envgroup~1page/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/envgroup/page","href":"group-management/envgrouppagepost","openApiOperationId":"envgroupPagePost","summary":"Get a list of groups"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_7","exampleIds":["paths/~1envgroup~1page/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_7","exampleIds":["paths/~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_8","exampleIds":["paths/~1envgroup~1page/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_8","exampleIds":["paths/~1envgroup~1page/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1envgroup~1page/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_8","exampleIds":["paths/~1envgroup~1page/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8","exampleIds":["paths/~1envgroup~1page/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-management/envgrouppagepost"}],"panels":[]}]},"httpPath":"/envgroup/page"},{"label":"Modify grouping information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/group-management/envgroupeditpost","routeSlug":"/api-reference/shared-resources/open-api/group-management/envgroupeditpost","metadata":{"seo":{"title":"Modify grouping information","description":"Rename a profile group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"envgroupEditPost","name":"Modify grouping information","deprecated":false,"isWebhook":false,"pointer":"/paths/~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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1envgroup~1edit/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_9","exampleIds":["paths/~1envgroup~1edit/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1envgroup~1edit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/envgroup/edit","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~1envgroup~1edit/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/envgroup/edit","href":"group-management/envgroupeditpost","openApiOperationId":"envgroupEditPost","summary":"Modify grouping information"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_9","exampleIds":["paths/~1envgroup~1edit/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_9","exampleIds":["paths/~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_10","exampleIds":["paths/~1envgroup~1edit/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_10","exampleIds":["paths/~1envgroup~1edit/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1envgroup~1edit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_10","exampleIds":["paths/~1envgroup~1edit/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_10","exampleIds":["paths/~1envgroup~1edit/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-management/envgroupeditpost"}],"panels":[]}]},"httpPath":"/envgroup/edit"},{"label":"Add group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/group-management/envgroupcreatepost","routeSlug":"/api-reference/shared-resources/open-api/group-management/envgroupcreatepost","metadata":{"seo":{"title":"Add group","description":"Create a profile group."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"envgroupCreatePost","name":"Add group","deprecated":false,"isWebhook":false,"pointer":"/paths/~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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1envgroup~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_11","exampleIds":["paths/~1envgroup~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1envgroup~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/envgroup/create","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~1envgroup~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/envgroup/create","href":"group-management/envgroupcreatepost","openApiOperationId":"envgroupCreatePost","summary":"Add group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_11","exampleIds":["paths/~1envgroup~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_11","exampleIds":["paths/~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_12","exampleIds":["paths/~1envgroup~1create/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_12","exampleIds":["paths/~1envgroup~1create/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1envgroup~1create/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","exampleIds":["paths/~1envgroup~1create/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12","exampleIds":["paths/~1envgroup~1create/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-management/envgroupcreatepost"}],"panels":[]}]},"httpPath":"/envgroup/create"},{"label":"Delete group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/group-management/envgroupdeletepost","routeSlug":"/api-reference/shared-resources/open-api/group-management/envgroupdeletepost","metadata":{"seo":{"title":"Delete group","description":"Delete one or more profile groups."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"envgroupDeletePost","name":"Delete group","deprecated":false,"isWebhook":false,"pointer":"/paths/~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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1envgroup~1delete/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_13","exampleIds":["paths/~1envgroup~1delete/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1envgroup~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/envgroup/delete","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~1envgroup~1delete/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/envgroup/delete","href":"group-management/envgroupdeletepost","openApiOperationId":"envgroupDeletePost","summary":"Delete group"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_13","exampleIds":["paths/~1envgroup~1delete/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_13","exampleIds":["paths/~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_14","exampleIds":["paths/~1envgroup~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_14","exampleIds":["paths/~1envgroup~1delete/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1envgroup~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_14","exampleIds":["paths/~1envgroup~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14","exampleIds":["paths/~1envgroup~1delete/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/group-management/envgroupdeletepost"}],"panels":[]}]},"httpPath":"/envgroup/delete"}],"content":{"contentType":"group","meta":{"name":"Group Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Group Management","showPageActions":true},{"nodeType":"markdoc","content":"Create, update, delete, and list environment groups"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/envgroup/page","summary":"Get a list of groups","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group-management/envgrouppagepost","deprecated":false},{"title":"/envgroup/edit","summary":"Modify grouping information","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group-management/envgroupeditpost","deprecated":false},{"title":"/envgroup/create","summary":"Add group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group-management/envgroupcreatepost","deprecated":false},{"title":"/envgroup/delete","summary":"Delete group","prefix":{"name":"post","color":"post"},"badges":[],"link":"/group-management/envgroupdeletepost","deprecated":false}]}]}]}]}},{"type":"group","label":"Tag Management","link":"/api-reference/shared-resources/open-api/tag-management","routeSlug":"/api-reference/shared-resources/open-api/tag-management","items":[{"label":"Getting a list of tags","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/tag-management/envtagallget","routeSlug":"/api-reference/shared-resources/open-api/tag-management/envtagallget","metadata":{"seo":{"title":"Getting a list of tags","description":"Return every profile tag in the team."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"envtagAllGet","name":"Getting a list of tags","deprecated":false,"isWebhook":false,"pointer":"/paths/~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":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/envtag/all","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/envtag/all","href":"tag-management/envtagallget","openApiOperationId":"envtagAllGet","summary":"Getting a list of tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api 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_15","exampleIds":["paths/~1envtag~1all/get/responses/200/content/application~1json/example"]}},"schemaId":"schema_15","exampleIds":["paths/~1envtag~1all/get/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1envtag~1all/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_15","exampleIds":["paths/~1envtag~1all/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_15","exampleIds":["paths/~1envtag~1all/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-management/envtagallget"}],"panels":[]}]},"httpPath":"/envtag/all"},{"label":"Create tags","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/tag-management/envtagcreatepost","routeSlug":"/api-reference/shared-resources/open-api/tag-management/envtagcreatepost","metadata":{"seo":{"title":"Create tags","description":"Create a profile tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"envtagCreatePost","name":"Create tags","deprecated":false,"isWebhook":false,"pointer":"/paths/~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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16","exampleIds":["paths/~1envtag~1create/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_16","exampleIds":["paths/~1envtag~1create/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1envtag~1create/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/envtag/create","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_16","exampleIds":["paths/~1envtag~1create/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/envtag/create","href":"tag-management/envtagcreatepost","openApiOperationId":"envtagCreatePost","summary":"Create tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_16","exampleIds":["paths/~1envtag~1create/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16","exampleIds":["paths/~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_17","exampleIds":["paths/~1envtag~1create/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_17","exampleIds":["paths/~1envtag~1create/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1envtag~1create/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_17","exampleIds":["paths/~1envtag~1create/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_17","exampleIds":["paths/~1envtag~1create/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-management/envtagcreatepost"}],"panels":[]}]},"httpPath":"/envtag/create"},{"label":"Modify information of tags","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/tag-management/envtageditpost","routeSlug":"/api-reference/shared-resources/open-api/tag-management/envtageditpost","metadata":{"seo":{"title":"Modify information of tags","description":"Rename a profile tag."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"envtagEditPost","name":"Modify information of tags","deprecated":false,"isWebhook":false,"pointer":"/paths/~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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1envtag~1edit/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_18","exampleIds":["paths/~1envtag~1edit/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1envtag~1edit/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/envtag/edit","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~1envtag~1edit/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/envtag/edit","href":"tag-management/envtageditpost","openApiOperationId":"envtagEditPost","summary":"Modify information of tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_18","exampleIds":["paths/~1envtag~1edit/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18","exampleIds":["paths/~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_19","exampleIds":["paths/~1envtag~1edit/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_19","exampleIds":["paths/~1envtag~1edit/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1envtag~1edit/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","exampleIds":["paths/~1envtag~1edit/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19","exampleIds":["paths/~1envtag~1edit/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-management/envtageditpost"}],"panels":[]}]},"httpPath":"/envtag/edit"},{"label":"Delete tags","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/tag-management/envtagdeletepost","routeSlug":"/api-reference/shared-resources/open-api/tag-management/envtagdeletepost","metadata":{"seo":{"title":"Delete tags","description":"Delete one or more profile tags."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"envtagDeletePost","name":"Delete tags","deprecated":false,"isWebhook":false,"pointer":"/paths/~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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1envtag~1delete/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_20","exampleIds":["paths/~1envtag~1delete/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1envtag~1delete/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/envtag/delete","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~1envtag~1delete/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/envtag/delete","href":"tag-management/envtagdeletepost","openApiOperationId":"envtagDeletePost","summary":"Delete tags"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_20","exampleIds":["paths/~1envtag~1delete/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_20","exampleIds":["paths/~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_14","exampleIds":["paths/~1envtag~1delete/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_14","exampleIds":["paths/~1envtag~1delete/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1envtag~1delete/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_14","exampleIds":["paths/~1envtag~1delete/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_14","exampleIds":["paths/~1envtag~1delete/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/tag-management/envtagdeletepost"}],"panels":[]}]},"httpPath":"/envtag/delete"}],"content":{"contentType":"group","meta":{"name":"Tag Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Tag Management","showPageActions":true},{"nodeType":"markdoc","content":"Create, update, delete, and list environment tags"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/envtag/all","summary":"Getting a list of tags","prefix":{"name":"get","color":"get"},"badges":[],"link":"/tag-management/envtagallget","deprecated":false},{"title":"/envtag/create","summary":"Create tags","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-management/envtagcreatepost","deprecated":false},{"title":"/envtag/edit","summary":"Modify information of tags","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-management/envtageditpost","deprecated":false},{"title":"/envtag/delete","summary":"Delete tags","prefix":{"name":"post","color":"post"},"badges":[],"link":"/tag-management/envtagdeletepost","deprecated":false}]}]}]}]}},{"type":"group","label":"Webhook Management","link":"/api-reference/shared-resources/open-api/webhook-management","routeSlug":"/api-reference/shared-resources/open-api/webhook-management","items":[{"label":"Configure the team webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api-reference/shared-resources/open-api/webhook-management/webhookconfigpost","routeSlug":"/api-reference/shared-resources/open-api/webhook-management/webhookconfigpost","metadata":{"seo":{"title":"Configure the team webhook","description":"Create or replace the team's webhook configuration."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookConfigPost","name":"Configure the team webhook","deprecated":false,"isWebhook":false,"pointer":"/paths/~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":"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":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1webhook~1config/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_21","exampleIds":["paths/~1webhook~1config/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1webhook~1config/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/webhook/config","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~1webhook~1config/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"/webhook/config","href":"webhook-management/webhookconfigpost","openApiOperationId":"webhookConfigPost","summary":"Configure the team webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"schema_21","exampleIds":["paths/~1webhook~1config/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21","exampleIds":["paths/~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_22","exampleIds":["paths/~1webhook~1config/post/responses/200/content/application~1json/example"]}},"schemaId":"schema_22","exampleIds":["paths/~1webhook~1config/post/responses/200/content/application~1json/example"],"headers":{}}],"pointer":"/paths/~1webhook~1config/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_22","exampleIds":["paths/~1webhook~1config/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_22","exampleIds":["paths/~1webhook~1config/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/webhookconfigpost"}],"panels":[]}]},"httpPath":"/webhook/config"},{"type":"separator","label":"Webhooks","variant":"secondary","content":null},{"label":"Cloud phone power on finished","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonepoweron","routeSlug":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonepoweron","metadata":{"seo":{"title":"Cloud phone power on finished","description":"Sent once a power-on reached its final result."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookCloudPhonePowerOn","name":"Cloud phone power on finished","isWebhook":true,"pointer":"/paths/cloud_phone.power_on/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud phone power on finished","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent once a power-on reached its final result."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only when the completion callback succeeded and the local synchronisation committed. A billing failure, or an asynchronous proxy check that fails and finishes its cleanup, reports a failed power on and does not emit a separate power off. Deferred work such as installing preset apps does not change the result."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a power off interrupts the boot, no power-on event is produced for that attempt; the later successful shutdown still produces its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cloud_phone.power_off"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Webhook-Event-Id","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body. Use it to make your handler idempotent."},"children":[]}]}]}],"required":true},{"name":"X-Webhook-Event-Type","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body, so you can route without parsing."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MoreLogin-Webhook/1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/cloud_phone.power_on/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.power_on/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.power_on/post/requestBody/content/application~1json/example"],"pointer":"/paths/cloud_phone.power_on/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cloud_phone.power_on","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Webhook-Event-Id","in":"header","required":true,"schemaId":"schema_23"},{"name":"X-Webhook-Event-Type","in":"header","required":true,"schemaId":"schema_23"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_23"}],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.power_on/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"cloud_phone.power_on","href":"webhook-management/webhookcloudphonepoweron","openApiOperationId":"webhookCloudPhonePowerOn","summary":"Cloud phone power on finished"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.power_on/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.power_on/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":"Any 2xx is treated as delivered. The response body is ignored, so return as early as you can and do the work asynchronously. Anything else, including a connection or read timeout, counts as a failure and is retried."}],"pointer":"/paths/cloud_phone.power_on/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/webhookcloudphonepoweron"}],"panels":[]}]},"httpPath":"cloud_phone.power_on"},{"label":"Cloud phone powered off","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonepoweroff","routeSlug":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonepoweroff","metadata":{"seo":{"title":"Cloud phone powered off","description":"Sent when a shutdown succeeded. A failed shutdown does not produce this event, so result.success is always true here."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookCloudPhonePowerOff","name":"Cloud phone powered off","isWebhook":true,"pointer":"/paths/cloud_phone.power_off/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud phone powered off","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent when a shutdown succeeded. A failed shutdown does not produce this event, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result.success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data.reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" records why the phone stopped."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Webhook-Event-Id","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body. Use it to make your handler idempotent."},"children":[]}]}]}],"required":true},{"name":"X-Webhook-Event-Type","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body, so you can route without parsing."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MoreLogin-Webhook/1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/cloud_phone.power_off/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhonePowerOffWebhookEvent","exampleIds":["paths/cloud_phone.power_off/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CloudPhonePowerOffWebhookEvent","exampleIds":["paths/cloud_phone.power_off/post/requestBody/content/application~1json/example"],"pointer":"/paths/cloud_phone.power_off/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cloud_phone.power_off","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Webhook-Event-Id","in":"header","required":true,"schemaId":"schema_23"},{"name":"X-Webhook-Event-Type","in":"header","required":true,"schemaId":"schema_23"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_23"}],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudPhonePowerOffWebhookEvent","exampleIds":["paths/cloud_phone.power_off/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"cloud_phone.power_off","href":"webhook-management/webhookcloudphonepoweroff","openApiOperationId":"webhookCloudPhonePowerOff","summary":"Cloud phone powered off"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"components/schemas/CloudPhonePowerOffWebhookEvent","exampleIds":["paths/cloud_phone.power_off/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhonePowerOffWebhookEvent","exampleIds":["paths/cloud_phone.power_off/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":"Any 2xx is treated as delivered. The response body is ignored, so return as early as you can and do the work asynchronously. Anything else, including a connection or read timeout, counts as a failure and is retried."}],"pointer":"/paths/cloud_phone.power_off/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/webhookcloudphonepoweroff"}],"panels":[]}]},"httpPath":"cloud_phone.power_off"},{"label":"Cloud phone restart finished","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonerestart","routeSlug":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonerestart","metadata":{"seo":{"title":"Cloud phone restart finished","description":"Sent once a restart reached its final result. success is true only when the completion callback succeeded and the local synchronisation committed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookCloudPhoneRestart","name":"Cloud phone restart finished","isWebhook":true,"pointer":"/paths/cloud_phone.restart/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud phone restart finished","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent once a restart reached its final result. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only when the completion callback succeeded and the local synchronisation committed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Webhook-Event-Id","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body. Use it to make your handler idempotent."},"children":[]}]}]}],"required":true},{"name":"X-Webhook-Event-Type","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body, so you can route without parsing."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MoreLogin-Webhook/1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/cloud_phone.restart/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.restart/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.restart/post/requestBody/content/application~1json/example"],"pointer":"/paths/cloud_phone.restart/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cloud_phone.restart","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Webhook-Event-Id","in":"header","required":true,"schemaId":"schema_23"},{"name":"X-Webhook-Event-Type","in":"header","required":true,"schemaId":"schema_23"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_23"}],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.restart/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"cloud_phone.restart","href":"webhook-management/webhookcloudphonerestart","openApiOperationId":"webhookCloudPhoneRestart","summary":"Cloud phone restart finished"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.restart/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.restart/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":"Any 2xx is treated as delivered. The response body is ignored, so return as early as you can and do the work asynchronously. Anything else, including a connection or read timeout, counts as a failure and is retried."}],"pointer":"/paths/cloud_phone.restart/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/webhookcloudphonerestart"}],"panels":[]}]},"httpPath":"cloud_phone.restart"},{"label":"Cloud phone reset finished","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonereset","routeSlug":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonereset","metadata":{"seo":{"title":"Cloud phone reset finished","description":"Sent once a reset reached its final result. success is true only when the completion callback succeeded and the local synchronisation committed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookCloudPhoneReset","name":"Cloud phone reset finished","isWebhook":true,"pointer":"/paths/cloud_phone.reset/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud phone reset finished","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent once a reset reached its final result. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only when the completion callback succeeded and the local synchronisation committed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Webhook-Event-Id","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body. Use it to make your handler idempotent."},"children":[]}]}]}],"required":true},{"name":"X-Webhook-Event-Type","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body, so you can route without parsing."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MoreLogin-Webhook/1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/cloud_phone.reset/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.reset/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.reset/post/requestBody/content/application~1json/example"],"pointer":"/paths/cloud_phone.reset/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cloud_phone.reset","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Webhook-Event-Id","in":"header","required":true,"schemaId":"schema_23"},{"name":"X-Webhook-Event-Type","in":"header","required":true,"schemaId":"schema_23"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_23"}],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.reset/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"cloud_phone.reset","href":"webhook-management/webhookcloudphonereset","openApiOperationId":"webhookCloudPhoneReset","summary":"Cloud phone reset finished"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.reset/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.reset/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":"Any 2xx is treated as delivered. The response body is ignored, so return as early as you can and do the work asynchronously. Anything else, including a connection or read timeout, counts as a failure and is retried."}],"pointer":"/paths/cloud_phone.reset/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/webhookcloudphonereset"}],"panels":[]}]},"httpPath":"cloud_phone.reset"},{"label":"Cloud phone one-click new machine finished","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonenewmachine","routeSlug":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudphonenewmachine","metadata":{"seo":{"title":"Cloud phone one-click new machine finished","description":"Sent once a one-click new machine operation reached its final result. success is true only when the completion callback succeeded and the local synchronisation committed."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookCloudPhoneNewMachine","name":"Cloud phone one-click new machine finished","isWebhook":true,"pointer":"/paths/cloud_phone.new_machine/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud phone one-click new machine finished","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent once a one-click new machine operation reached its final result. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"success"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" only when the completion callback succeeded and the local synchronisation committed."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Webhook-Event-Id","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body. Use it to make your handler idempotent."},"children":[]}]}]}],"required":true},{"name":"X-Webhook-Event-Type","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body, so you can route without parsing."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MoreLogin-Webhook/1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/cloud_phone.new_machine/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.new_machine/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.new_machine/post/requestBody/content/application~1json/example"],"pointer":"/paths/cloud_phone.new_machine/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cloud_phone.new_machine","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Webhook-Event-Id","in":"header","required":true,"schemaId":"schema_23"},{"name":"X-Webhook-Event-Type","in":"header","required":true,"schemaId":"schema_23"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_23"}],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.new_machine/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"cloud_phone.new_machine","href":"webhook-management/webhookcloudphonenewmachine","openApiOperationId":"webhookCloudPhoneNewMachine","summary":"Cloud phone one-click new machine finished"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.new_machine/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudPhoneWebhookEvent","exampleIds":["paths/cloud_phone.new_machine/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":"Any 2xx is treated as delivered. The response body is ignored, so return as early as you can and do the work asynchronously. Anything else, including a connection or read timeout, counts as a failure and is retried."}],"pointer":"/paths/cloud_phone.new_machine/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/webhookcloudphonenewmachine"}],"panels":[]}]},"httpPath":"cloud_phone.new_machine"},{"label":"Cloud browser start finished","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudbrowserstart","routeSlug":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudbrowserstart","metadata":{"seo":{"title":"Cloud browser start finished","description":"Sent once a cloud browser start reached its final result."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookCloudBrowserStart","name":"Cloud browser start finished","isWebhook":true,"pointer":"/paths/cloud_browser.start/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud browser start finished","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sent once a cloud browser start reached its final result."},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Webhook-Event-Id","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body. Use it to make your handler idempotent."},"children":[]}]}]}],"required":true},{"name":"X-Webhook-Event-Type","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body, so you can route without parsing."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MoreLogin-Webhook/1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/cloud_browser.start/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudBrowserWebhookEvent","exampleIds":["paths/cloud_browser.start/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CloudBrowserWebhookEvent","exampleIds":["paths/cloud_browser.start/post/requestBody/content/application~1json/example"],"pointer":"/paths/cloud_browser.start/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cloud_browser.start","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Webhook-Event-Id","in":"header","required":true,"schemaId":"schema_23"},{"name":"X-Webhook-Event-Type","in":"header","required":true,"schemaId":"schema_23"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_23"}],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudBrowserWebhookEvent","exampleIds":["paths/cloud_browser.start/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"cloud_browser.start","href":"webhook-management/webhookcloudbrowserstart","openApiOperationId":"webhookCloudBrowserStart","summary":"Cloud browser start finished"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"components/schemas/CloudBrowserWebhookEvent","exampleIds":["paths/cloud_browser.start/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudBrowserWebhookEvent","exampleIds":["paths/cloud_browser.start/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":"Any 2xx is treated as delivered. The response body is ignored, so return as early as you can and do the work asynchronously. Anything else, including a connection or read timeout, counts as a failure and is retried."}],"pointer":"/paths/cloud_browser.start/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/webhookcloudbrowserstart"}],"panels":[]}]},"httpPath":"cloud_browser.start"},{"label":"Cloud browser stop finished","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudbrowserstop","routeSlug":"/api-reference/shared-resources/open-api/webhook-management/webhookcloudbrowserstop","metadata":{"seo":{"title":"Cloud browser stop finished","description":"Sent for every cloud browser stop attempt, successful or not. Reaching the stop-failed state is itself a failed result for that attempt; a later manual retry or forced release counts as a new operation and produces a new eventId."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"webhookCloudBrowserStop","name":"Cloud browser stop finished","isWebhook":true,"pointer":"/paths/cloud_browser.stop/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cloud browser stop finished","isWebhook":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent for every cloud browser stop attempt, successful or not. Reaching the stop-failed state is itself a failed result for that attempt; a later manual retry or forced release counts as a new operation and produces a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Events are deduplicated per stop operation, so one attempt never yields two events and two attempts are never merged. An internal archiving failure changes only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"result"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; it never overwrites the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" captured when the stop began."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"X-Webhook-Event-Id","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body. Use it to make your handler idempotent."},"children":[]}]}]}],"required":true},{"name":"X-Webhook-Event-Type","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eventType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the body, so you can route without parsing."},"children":[]}]}]}],"required":true},{"name":"User-Agent","in":"header","schemaId":"schema_23","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MoreLogin-Webhook/1.0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true}],"pointer":"/paths/cloud_browser.stop/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudBrowserStopWebhookEvent","exampleIds":["paths/cloud_browser.stop/post/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/CloudBrowserStopWebhookEvent","exampleIds":["paths/cloud_browser.stop/post/requestBody/content/application~1json/example"],"pointer":"/paths/cloud_browser.stop/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"webhook","method":"POST","path":"cloud_browser.stop","servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"X-Webhook-Event-Id","in":"header","required":true,"schemaId":"schema_23"},{"name":"X-Webhook-Event-Type","in":"header","required":true,"schemaId":"schema_23"},{"name":"User-Agent","in":"header","required":true,"schemaId":"schema_23"}],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CloudBrowserStopWebhookEvent","exampleIds":["paths/cloud_browser.stop/post/requestBody/content/application~1json/example"]}},"responseCodes":["200"],"pointer":"cloud_browser.stop","href":"webhook-management/webhookcloudbrowserstop","openApiOperationId":"webhookCloudBrowserStop","summary":"Cloud browser stop finished"},"isWebhook":true,"hideReplay":false,"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"schemaId":"components/schemas/CloudBrowserStopWebhookEvent","exampleIds":["paths/cloud_browser.stop/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CloudBrowserStopWebhookEvent","exampleIds":["paths/cloud_browser.stop/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":"Any 2xx is treated as delivered. The response body is ignored, so return as early as you can and do the work asynchronously. Anything else, including a connection or read timeout, counts as a failure and is retried."}],"pointer":"/paths/cloud_browser.stop/post/responses"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/webhook-management/webhookcloudbrowserstop"}],"panels":[]}]},"httpPath":"cloud_browser.stop"}],"content":{"contentType":"group","meta":{"name":"Webhook Management"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Webhook Management","showPageActions":true},{"nodeType":"markdoc","content":"Configure the team callback endpoint that receives webhook events"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/webhook/config","summary":"Configure the team webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-management/webhookconfigpost","deprecated":false}]},{"kind":"group-items","title":"Webhooks","titleTranslationKey":"webhooks","items":[{"title":"cloud_phone.power_on","summary":"Cloud phone power on finished","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-management/webhookcloudphonepoweron","deprecated":false},{"title":"cloud_phone.power_off","summary":"Cloud phone powered off","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-management/webhookcloudphonepoweroff","deprecated":false},{"title":"cloud_phone.restart","summary":"Cloud phone restart finished","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-management/webhookcloudphonerestart","deprecated":false},{"title":"cloud_phone.reset","summary":"Cloud phone reset finished","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-management/webhookcloudphonereset","deprecated":false},{"title":"cloud_phone.new_machine","summary":"Cloud phone one-click new machine finished","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-management/webhookcloudphonenewmachine","deprecated":false},{"title":"cloud_browser.start","summary":"Cloud browser start finished","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-management/webhookcloudbrowserstart","deprecated":false},{"title":"cloud_browser.stop","summary":"Cloud browser stop finished","prefix":{"name":"post","color":"post"},"badges":[],"link":"/webhook-management/webhookcloudbrowserstop","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/WebhookResult":{"id":"components/schemas/WebhookResult","kind":"json-schema","title":"WebhookResult","data":{"type":"object","description":"The final outcome of the operation the event describes.","properties":{"success":{"description":"Whether the operation ultimately succeeded.","type":"boolean"},"code":{"description":[{"$$mdtype":"Node","type":"paragraph","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":" on success. On failure, a stable business error code that does not depend on language."},"children":[]}]}]}],"type":"string"},"message":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on success. On failure, an explanation in the team's language, falling back to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"en-US"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when that language or its text is unavailable."},"children":[]}]}]}],"type":["string","null"]}},"required":["success","code","message"]}},"components/schemas/CloudPhoneWebhookEvent":{"id":"components/schemas/CloudPhoneWebhookEvent","kind":"json-schema","title":"CloudPhoneWebhookEvent","data":{"type":"object","properties":{"eventId":{"description":"Unique event ID. Delivery retries and internal replays of the same event reuse it, so treat it as the idempotency key.","type":"string"},"eventType":{"description":"Stable event name.","type":"string"},"eventTime":{"description":"When the final business result happened, as Unix epoch milliseconds. Sent as a string.","type":"string"},"data":{"type":"object","properties":{"teamId":{"description":"The team that owns the resource.","type":"string"},"cloudPhoneId":{"description":"The cloud phone the event is about.","type":"string"}},"required":["teamId","cloudPhoneId"]},"result":{"$ref":"#/components/schemas/WebhookResult"}},"required":["eventId","eventType","eventTime","data","result"]}},"components/schemas/CloudPhonePowerOffWebhookEvent":{"id":"components/schemas/CloudPhonePowerOffWebhookEvent","kind":"json-schema","title":"CloudPhonePowerOffWebhookEvent","data":{"type":"object","properties":{"eventId":{"description":"Unique event ID. Delivery retries and internal replays of the same event reuse it, so treat it as the idempotency key.","type":"string"},"eventType":{"description":"Stable event name.","type":"string"},"eventTime":{"description":"When the final business result happened, as Unix epoch milliseconds. Sent as a string.","type":"string"},"data":{"type":"object","properties":{"teamId":{"description":"The team that owns the resource.","type":"string"},"cloudPhoneId":{"description":"The cloud phone the event is about.","type":"string"},"reason":{"description":"Why the phone stopped.","type":"string","enum":["NORMAL","MONEY_SAVING","OTHER"]}},"required":["teamId","cloudPhoneId","reason"]},"result":{"$ref":"#/components/schemas/WebhookResult"}},"required":["eventId","eventType","eventTime","data","result"]}},"components/schemas/CloudBrowserWebhookEvent":{"id":"components/schemas/CloudBrowserWebhookEvent","kind":"json-schema","title":"CloudBrowserWebhookEvent","data":{"type":"object","properties":{"eventId":{"description":"Unique event ID. Delivery retries and internal replays of the same event reuse it, so treat it as the idempotency key.","type":"string"},"eventType":{"description":"Stable event name.","type":"string"},"eventTime":{"description":"When the final business result happened, as Unix epoch milliseconds. Sent as a string.","type":"string"},"data":{"type":"object","properties":{"teamId":{"description":"The team that owns the resource.","type":"string"},"cloudBrowserId":{"description":"The cloud browser profile the event is about.","type":"string"},"runId":{"description":"The run instance the event is about.","type":"string"}},"required":["teamId","cloudBrowserId","runId"]},"result":{"$ref":"#/components/schemas/WebhookResult"}},"required":["eventId","eventType","eventTime","data","result"]}},"components/schemas/CloudBrowserStopWebhookEvent":{"id":"components/schemas/CloudBrowserStopWebhookEvent","kind":"json-schema","title":"CloudBrowserStopWebhookEvent","data":{"type":"object","properties":{"eventId":{"description":"Unique event ID. Delivery retries and internal replays of the same event reuse it, so treat it as the idempotency key.","type":"string"},"eventType":{"description":"Stable event name.","type":"string"},"eventTime":{"description":"When the final business result happened, as Unix epoch milliseconds. Sent as a string.","type":"string"},"data":{"type":"object","properties":{"teamId":{"description":"The team that owns the resource.","type":"string"},"cloudBrowserId":{"description":"The cloud browser profile the event is about.","type":"string"},"runId":{"description":"The run instance the event is about.","type":"string"},"reason":{"description":"Why the run stopped.","type":"string","enum":["NORMAL","MONEY_SAVING","ENERGY_SAVING","BROWSER_EXITED","OTHER"]}},"required":["teamId","cloudBrowserId","runId","reason"]},"result":{"$ref":"#/components/schemas/WebhookResult"}},"required":["eventId","eventType","eventTime","data","result"]}},"schema_0":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","pattern":"^\\d+$","description":"Optional proxy ID for an exact match. Send the 64-bit ID as a decimal string to avoid precision loss. Omit it to query without an ID filter. Other filters and pagination still apply.","example":"1800000000000101"},"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 type 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":" = None"},"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_0"},"schema_1":{"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"},"state":{"type":["string","null"],"description":"Proxy state or province. Uses detected exit-IP location when available, otherwise the configured location; may be null or empty.","example":"California"},"city":{"type":["string","null"],"description":"Proxy city. Uses detected exit-IP location when available, otherwise the configured location; may be null or empty.","example":"Los Angeles"},"proxyPort":{"type":["integer","null"],"format":"int32","description":"Proxy connection port, not a port inferred from the proxy name. May be null when unavailable.","example":1080},"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 type:default value 0 - none 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_1"},"schema_2":{"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 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_2"},"schema_3":{"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_3"},"schema_4":{"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 type 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 (type-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 the proxy type)"},"state":{"type":"string","description":"Reserved field or custom state (optional)"}}},"id":"schema_4"},"schema_5":{"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_5"},"schema_6":{"kind":"json-schema","data":{"type":"array","items":{"type":"integer","format":"int64"}},"id":"schema_6"},"schema_7":{"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_7"},"schema_8":{"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_8"},"schema_9":{"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_9"},"schema_10":{"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_10"},"schema_11":{"kind":"json-schema","data":{"type":"object","properties":{}},"id":"schema_11"},"schema_12":{"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_12"},"schema_13":{"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_13"},"schema_14":{"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_14"},"schema_15":{"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_15"},"schema_16":{"kind":"json-schema","data":{"type":"object","properties":{"tagName":{"type":"string","description":"tag name"}}},"id":"schema_16"},"schema_17":{"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_17"},"schema_18":{"kind":"json-schema","data":{"type":"object","properties":{"id":{"type":"string","description":"tag id"},"tagName":{"type":"string","description":"tag name"}}},"id":"schema_18"},"schema_19":{"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_19"},"schema_20":{"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_20"},"schema_21":{"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_21"},"schema_22":{"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_22"},"schema_23":{"kind":"json-schema","data":{"type":"string"},"id":"schema_23"}},"exampleStore":{"paths/~1proxyInfo~1page/post/requestBody/content/application~1json/example":{"value":{"id":"1800000000000101","pageNo":1,"pageSize":10,"isCloudPhoneProxy":false,"proxyCategoryType":2,"proxyIp":"","proxyName":"","proxyProviders":[],"proxyStatus":1,"proxyCheckStatus":1,"proxyTypes":[]},"id":"paths/~1proxyInfo~1page/post/requestBody/content/application~1json/example"},"paths/~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,"state":"California","city":"Los Angeles","proxyPort":1080,"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/~1proxyInfo~1page/post/responses/200/content/application~1json/example"},"paths/~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/~1proxyInfo~1add/post/requestBody/content/application~1json/example"},"paths/~1proxyInfo~1add/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":0,"requestId":"abcd1234"},"id":"paths/~1proxyInfo~1add/post/responses/200/content/application~1json/example"},"paths/~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/~1proxyInfo~1update/post/requestBody/content/application~1json/example"},"paths/~1proxyInfo~1update/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","requestId":"efgh5678"},"id":"paths/~1proxyInfo~1update/post/responses/200/content/application~1json/example"},"paths/~1proxyInfo~1delete/post/requestBody/content/application~1json/example":{"value":[1054661322597744600,1054661322597744600],"id":"paths/~1proxyInfo~1delete/post/requestBody/content/application~1json/example"},"paths/~1proxyInfo~1delete/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","requestId":"ijkl9012"},"id":"paths/~1proxyInfo~1delete/post/responses/200/content/application~1json/example"},"paths/~1envgroup~1page/post/requestBody/content/application~1json/example":{"value":{"groupName":"132-kernel","pageNo":1,"pageSize":10},"id":"paths/~1envgroup~1page/post/requestBody/content/application~1json/example"},"paths/~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/~1envgroup~1page/post/responses/200/content/application~1json/example"},"paths/~1envgroup~1edit/post/requestBody/content/application~1json/example":{"value":{"groupName":"Group-1574544945848579","id":"1574525425557584"},"id":"paths/~1envgroup~1edit/post/requestBody/content/application~1json/example"},"paths/~1envgroup~1edit/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":null,"data":true,"requestId":"0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"},"id":"paths/~1envgroup~1edit/post/responses/200/content/application~1json/example"},"paths/~1envgroup~1create/post/requestBody/content/application~1json/example":{"value":{},"id":"paths/~1envgroup~1create/post/requestBody/content/application~1json/example"},"paths/~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/~1envgroup~1create/post/responses/200/content/application~1json/example"},"paths/~1envgroup~1delete/post/requestBody/content/application~1json/example":{"value":{"ids":["string"]},"id":"paths/~1envgroup~1delete/post/requestBody/content/application~1json/example"},"paths/~1envgroup~1delete/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":true,"requestId":""},"id":"paths/~1envgroup~1delete/post/responses/200/content/application~1json/example"},"paths/~1envtag~1all/get/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":[{"id":"0","tagName":""}],"requestId":""},"id":"paths/~1envtag~1all/get/responses/200/content/application~1json/example"},"paths/~1envtag~1create/post/requestBody/content/application~1json/example":{"value":{"tagName":"Tag-123"},"id":"paths/~1envtag~1create/post/requestBody/content/application~1json/example"},"paths/~1envtag~1create/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":{"id":"0","tagName":""},"requestId":""},"id":"paths/~1envtag~1create/post/responses/200/content/application~1json/example"},"paths/~1envtag~1edit/post/requestBody/content/application~1json/example":{"value":{"id":"1564715845550177","tagName":"Updated-123"},"id":"paths/~1envtag~1edit/post/requestBody/content/application~1json/example"},"paths/~1envtag~1edit/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":true,"requestId":""},"id":"paths/~1envtag~1edit/post/responses/200/content/application~1json/example"},"paths/~1envtag~1delete/post/requestBody/content/application~1json/example":{"value":{"ids":["string"]},"id":"paths/~1envtag~1delete/post/requestBody/content/application~1json/example"},"paths/~1envtag~1delete/post/responses/200/content/application~1json/example":{"value":{"code":0,"msg":"","data":true,"requestId":""},"id":"paths/~1envtag~1delete/post/responses/200/content/application~1json/example"},"paths/~1webhook~1config/post/requestBody/content/application~1json/example":{"value":{"callbackUrl":"https://example.com/morelogin/webhook","enabled":true},"id":"paths/~1webhook~1config/post/requestBody/content/application~1json/example"},"paths/~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/~1webhook~1config/post/responses/200/content/application~1json/example"},"paths/cloud_phone.power_on/post/requestBody/content/application~1json/example":{"value":{"eventId":"c7f3a2b10d8e4f6a9c1b2d3e4f5a6b7c","eventType":"cloud_phone.power_on","eventTime":"1787241600000","data":{"teamId":"10001","cloudPhoneId":"20001"},"result":{"success":false,"code":"33318","message":"Operation failed"}},"id":"paths/cloud_phone.power_on/post/requestBody/content/application~1json/example"},"paths/cloud_phone.power_off/post/requestBody/content/application~1json/example":{"value":{"eventId":"5b1d0c9e7a2f4d38b6c5a4e3f2d1c0b9","eventType":"cloud_phone.power_off","eventTime":"1787241600000","data":{"teamId":"10001","cloudPhoneId":"20001","reason":"MONEY_SAVING"},"result":{"success":true,"code":"0","message":null}},"id":"paths/cloud_phone.power_off/post/requestBody/content/application~1json/example"},"paths/cloud_phone.restart/post/requestBody/content/application~1json/example":{"value":{"eventId":"9e4c1a7b3f2d40518a6b5c4d3e2f1a0b","eventType":"cloud_phone.restart","eventTime":"1787241600000","data":{"teamId":"10001","cloudPhoneId":"20001"},"result":{"success":true,"code":"0","message":null}},"id":"paths/cloud_phone.restart/post/requestBody/content/application~1json/example"},"paths/cloud_phone.reset/post/requestBody/content/application~1json/example":{"value":{"eventId":"2f8a6d4c0b9e47138c7d6e5f4a3b2c1d","eventType":"cloud_phone.reset","eventTime":"1787241600000","data":{"teamId":"10001","cloudPhoneId":"20001"},"result":{"success":true,"code":"0","message":null}},"id":"paths/cloud_phone.reset/post/requestBody/content/application~1json/example"},"paths/cloud_phone.new_machine/post/requestBody/content/application~1json/example":{"value":{"eventId":"7c3b1e9d5a4f42068b1c2d3e4f5a6b70","eventType":"cloud_phone.new_machine","eventTime":"1787241600000","data":{"teamId":"10001","cloudPhoneId":"20001"},"result":{"success":true,"code":"0","message":null}},"id":"paths/cloud_phone.new_machine/post/requestBody/content/application~1json/example"},"paths/cloud_browser.start/post/requestBody/content/application~1json/example":{"value":{"eventId":"4a9f2c7e1b8d43509c6a5b4c3d2e1f00","eventType":"cloud_browser.start","eventTime":"1787241600000","data":{"teamId":"10001","cloudBrowserId":"30001","runId":"40001"},"result":{"success":true,"code":"0","message":null}},"id":"paths/cloud_browser.start/post/requestBody/content/application~1json/example"},"paths/cloud_browser.stop/post/requestBody/content/application~1json/example":{"value":{"eventId":"c7f3a2b10d8e4f6a9c1b2d3e4f5a6b7c","eventType":"cloud_browser.stop","eventTime":"1787241600000","data":{"teamId":"10001","cloudBrowserId":"30001","runId":"40001","reason":"BROWSER_EXITED"},"result":{"success":false,"code":"40006","message":"Operation failed"}},"id":"paths/cloud_browser.stop/post/requestBody/content/application~1json/example"}},"securitySchemeStore":{"Authorization":{"id":"Authorization","type":"http","scheme":"bearer","bearerFormat":"JWT","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Token for request access token interface response access_token field"},"children":[]}]}]}]}},"servers":[{"url":"https://api.morelogin.com","description":"MoreLogin open api endpoint"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/API Reference/Shared Resources/open-api.json?download"},{"url":"/_bundle/API Reference/Shared Resources/open-api.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Shared Resources Open API","description":"Manage shared resources (proxies, groups, and tags) through the MoreLogin Open API.\n\n**Base URL**: `https://api.morelogin.com`\n\nAuthentication is done via OAuth2 Bearer token. See [Authentication](../Getting%20Started/authentication.md) for details.\n"}},"baseSlug":"/api-reference/shared-resources/open-api","routesMapping":{}}