更新空间

1 分

POST

https://api.archbee.com/api/public-api/space/update

Update space fields.

Header Parameters

Content-Typestringrequired
Example
application/json

Body Parameters

bodyobjectrequired
- publicAccessControlPartobject
  Description
  Configuration for public access control and authentication
  - publicProtectionTypestring<None | Password | Guest accounts | Private Accounts | Private Link | Magic Link | JWT | SAML>
    Example
    Password
    Description
    Type of protection for the space
    Allowed
    NonePasswordGuest accountsPrivate AccountsPrivate LinkMagic LinkJWTSAML
  - publicPasswordstring
    Example
    mySecurePassword123
    Description
    Password required when publicProtectionType is 'Password'
  - publicGuestAccountsobject[]
    Description
    Guest accounts required when publicProtectionType is 'Guest accounts'
    - emailstring<email>
      Example
      [email protected]
      Format
      email
    - passwordstring
      Example
      guestPassword123
  - publicMagicLinkAccountsobject[]
    Description
    Magic link accounts required when publicProtectionType is 'Magic Link'
    - emailstring<email>
      Example
      [email protected]
      Format
      email
  - publicPrivateAccountsobject[]
    Description
    Private accounts required when publicProtectionType is 'Private Accounts'
    - emailstring<email>
      Example
      [email protected]
      Format
      email
  - privateLinkTokensobject[]
    Description
    Private link tokens required when publicProtectionType is 'Private Link'
    - descriptionstring
      Example
      API Access Token
    - envstring
      Example
      production
    - tokenstring
      Example
      eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9
  - jwtValidationTypestring<JWT-Secret | JWT-KeySet>
    Example
    JWT-Secret
    Description
    JWT validation type required when publicProtectionType is 'JWT'
    Allowed
    JWT-SecretJWT-KeySet
  - jwtKeyUrlstring
    Example
    https://example.com/.well-known/jwks.json
    Description
    JWT key URL required when jwtValidationType is 'JWT-KeySet'
  - jwtSecretstring
    Example
    myJwtSecret123
    Description
    JWT secret required when jwtValidationType is 'JWT-Secret'
  - conditionalRuleIdstring
    Example
    21-character__string0
    Description
    Conditional rule ID for advanced access control
  - jwtRedirectURLstring
    Example
    https://example.com/auth/callback
    Description
    JWT redirect URL for authentication flow
  - samlMetadatastring
    Example
    <EntityDescriptor>...</EntityDescriptor>
    Description
    SAML metadata required when publicProtectionType is 'SAML'
- hostnamePartobject
  Description
  Custom hostname configuration for the space
  - hostnamestring
    Example
    docs.example.com
    Description
    Custom hostname for the space
  - hostnamePathstring
    Example
    /api-docs
    Description
    Path component for the hostname
- spaceLinksobject[]
  Description
  Links to other spaces. List should start with current space.
  - labelstring
    Example
    Related Documentation
  - docSpaceIdstring
    Example
    21-character__string0

Responses

200Process status

object
Description
Process status
- statusstring<OK>
  Description
  Response Status
  Allowed
  OK
- dataobject
  Description
  DocSpace id
  - idstring
    Description
    doc space id

400Invalid request

Response400
- statusstring<OK | Not OK>
  Example
  Not OK
  Description
  Response Status
  Allowed
  OKNot OK
- messagesstring[]
  Example
```
[
  "Some error message"
]
```
  Description
  Array of messages

curl

curl --request POST \
     --url https://api.archbee.com/api/public-api/space/update \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.archbee.com/api/public-api/space/update", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.archbee.com/api/public-api/space/update")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.archbee.com/api/public-api/space/update"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

200

// Process status
{
  "status": "",
  "data": {
    "id": ""
  }
}

400

// Invalid request
{
  "status": "Not OK",
  "messages": [
    "Some error message"
  ]
}

Have a question?

Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.

To ask a question or participate in discussions, you'll need to authenticate first.