Update Space
0 min
{ "id" "ajcs0cfeir57qj2uxadqd", "type" "api oas v2", "data" { "method" "post", "url" " https //api archbee com/api/public api/space/update https //api archbee com/api/public api/space/update ", "servers" \[ { "url" " https //api archbee com/api/public api/space/update https //api archbee com/api/public api/space/update ", "description" "archbee api server" } ], "name" "update space", "description" "update space fields ", "contenttype" "application/json", "request" { "pathparameters" \[], "headerparameters" \[ { "kind" "required", "name" "content type", "type" "string", "example" "application/json", "description" "" } ], "queryparameters" \[], "bodydataparameters" \[ { "kind" "required", "name" "body", "type" "object", "description" "", "schema" \[ { "name" "publicaccesscontrolpart", "kind" "optional", "type" "object", "description" "configuration for public access control and authentication", "example" "", "schema" \[ { "name" "publicprotectiontype", "kind" "optional", "type" "string\<none | password | guest accounts | private accounts | private link | magic link | jwt | saml>", "description" "type of protection for the space", "example" "password" }, { "name" "publicpassword", "kind" "optional", "type" "string", "description" "password required when publicprotectiontype is 'password'", "example" "mysecurepassword123" }, { "name" "publicguestaccounts", "kind" "optional", "type" "array", "description" "guest accounts required when publicprotectiontype is 'guest accounts'", "example" "", "itemtype" "object", "customtype" "object\[]", "schema" \[ { "name" "email", "kind" "optional", "type" "string ", "description" "", "example" " guest\@example com mailto\ guest\@example com " }, { "name" "password", "kind" "optional", "type" "string", "description" "", "example" "guestpassword123" } ] }, { "name" "publicmagiclinkaccounts", "kind" "optional", "type" "array", "description" "magic link accounts required when publicprotectiontype is 'magic link'", "example" "", "itemtype" "object", "customtype" "object\[]", "schema" \[ { "name" "email", "kind" "optional", "type" "string ", "description" "", "example" " user\@example com mailto\ user\@example com " } ] }, { "name" "publicprivateaccounts", "kind" "optional", "type" "array", "description" "private accounts required when publicprotectiontype is 'private accounts'", "example" "", "itemtype" "object", "customtype" "object\[]", "schema" \[ { "name" "email", "kind" "optional", "type" "string ", "description" "", "example" " private\@example com mailto\ private\@example com " } ] }, { "name" "privatelinktokens", "kind" "optional", "type" "array", "description" "private link tokens required when publicprotectiontype is 'private link'", "example" "", "itemtype" "object", "customtype" "object\[]", "schema" \[ { "name" "description", "kind" "optional", "type" "string", "description" "", "example" "api access token" }, { "name" "env", "kind" "optional", "type" "string", "description" "", "example" "production" }, { "name" "token", "kind" "optional", "type" "string", "description" "", "example" "eyjhbgcioijiuzi1niisinr5cci6ikpxvcj9" } ] }, { "name" "jwtvalidationtype", "kind" "optional", "type" "string\<jwt secret | jwt keyset>", "description" "jwt validation type required when publicprotectiontype is 'jwt'", "example" "jwt secret" }, { "name" "jwtkeyurl", "kind" "optional", "type" "string", "description" "jwt key url required when jwtvalidationtype is 'jwt keyset'", "example" " https //example com/ well known/jwks json https //example com/ well known/jwks json " }, { "name" "jwtsecret", "kind" "optional", "type" "string", "description" "jwt secret required when jwtvalidationtype is 'jwt secret'", "example" "myjwtsecret123" }, { "name" "conditionalruleid", "kind" "optional", "type" "string", "description" "conditional rule id for advanced access control", "example" "21 character string0" }, { "name" "jwtredirecturl", "kind" "optional", "type" "string", "description" "jwt redirect url for authentication flow", "example" " https //example com/auth/callback https //example com/auth/callback " }, { "name" "samlmetadata", "kind" "optional", "type" "string", "description" "saml metadata required when publicprotectiontype is 'saml'", "example" " " } ] }, { "name" "hostnamepart", "kind" "optional", "type" "object", "description" "custom hostname configuration for the space", "example" "", "schema" \[ { "name" "hostname", "kind" "optional", "type" "string", "description" "custom hostname for the space", "example" "docs example com" }, { "name" "hostnamepath", "kind" "optional", "type" "string", "description" "path component for the hostname", "example" "/api docs" } ] }, { "name" "spacelinks", "kind" "optional", "type" "array", "description" "links to other spaces list should start with current space ", "example" "", "itemtype" "object", "customtype" "object\[]", "schema" \[ { "name" "label", "kind" "optional", "type" "string", "description" "", "example" "related documentation" }, { "name" "docspaceid", "kind" "optional", "type" "string", "description" "", "example" "21 character string0" } ] } ], "isexpanded" true } ], "formdataparameters" \[], "oauthparameters" \[ { "id" "bearerauth", "name" "bearerauth", "kind" "optional", "type" "http", "description" " requires the authorization header in the form authorization bearer {base64(docspaceid apikey)} where the token is base64 encoding of docspaceid, tilde, and apikey ", "scheme" "bearer" } ] }, "responses" \[ { "statuscode" "200", "description" "process status", "jsonexample" "", "isexpanded" true, "schema" \[ { "kind" "optional", "type" "object", "description" "process status", "schema" \[ { "name" "status", "kind" "optional", "type" "string ", "description" "response status", "example" "" }, { "name" "data", "kind" "optional", "type" "object", "description" "docspace id", "example" "", "schema" \[ { "name" "id", "kind" "optional", "type" "string", "description" "doc space id", "example" "" } ] } ], "isexpanded" true } ] }, { "statuscode" "400", "description" "invalid request", "jsonexample" "", "isexpanded" true, "schema" \[ { "kind" "optional", "type" "object", "description" "", "customtype" "response400", "schema" \[ { "name" "status", "kind" "optional", "type" "string\<ok | not ok>", "description" "response status", "example" "not ok" }, { "name" "messages", "kind" "optional", "type" "array", "description" "array of messages", "example" "\["some error message"]", "itemtype" "string", "customtype" "string\[]", "itemexample" "some error message", "itemdefault" "" } ], "modelref" "#/components/schemas/response400", "isexpanded" true } ] } ], "hasxcodesamples" false, "examples" { "languages" \[ { "id" "yiyih5jgallnaezde5q6t", "language" "curl", "label" "curl", "code" "curl request post \\\n url https //api archbee com/api/public api/space/update https //api archbee com/api/public api/space/update \\\n header 'accept application/json'" }, { "id" "wpula24k3tjyn1urld816", "language" "javascript", "label" "javascript", "code" "var myheaders = new headers();\nmyheaders append("accept", "application/json");\nmyheaders append("content type", "application/json");\n\nvar requestoptions = {\n method 'post',\n headers myheaders,\n redirect 'follow'\n};\n\nfetch(" https //api archbee com/api/public api/space/update https //api archbee com/api/public api/space/update ", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));" }, { "id" "qs70nkictxrf2e4m3tj1k", "language" "ruby", "label" "ruby", "code" "require "uri"\nrequire "json"\nrequire "net/http"\n\nurl = uri(" https //api archbee com/api/public api/space/update")\n\nhttps https //api archbee com/api/public api/space/update")\n\nhttps = net http new(url host, url port)\nhttps use ssl = true\n\nrequest = net http post new(url)\nrequest\["accept"] = "application/json"\nrequest\["content type"] = "application/json"\n\nresponse = https request(request)\nputs response read body\n" }, { "id" "zclslozxr oornm0 qdc", "language" "python", "label" "python", "code" "import requests\nimport json\n\nurl = " https //api archbee com/api/public api/space/update"\n\npayload https //api archbee com/api/public api/space/update"\n\npayload = {}\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request("post", url, headers=headers, data=payload)\n\nprint(response text)\n" } ], "selectedlanguageid" "yiyih5jgallnaezde5q6t" }, "results" { "languages" \[ { "id" "ayedyeibh2u9mjiqp7mrt", "language" "200", "code" "// process status\n{\n "status" "",\n "data" {\n "id" ""\n }\n}" }, { "id" "yikurwtnhhwi2ybnwp34y", "language" "400", "code" "// invalid request\n{\n "status" "not ok",\n "messages" \[\n "some error message"\n ]\n}" } ], "selectedlanguageid" "ayedyeibh2u9mjiqp7mrt" } }, "children" \[ { "text" "" } ] }