Get Unit Metadata
Overview
Get the metadata of Unit. The metadata includes the following information.
- Unit URL
- URL format for accessing cell in Unit
Required Privileges
None
Request
Request URL
{UnitURL}
Request Method
GET
Request Query
None
Request Header
| Header Name | Overview | Effective Value | Required | Notes |
|---|---|---|---|---|
| Accept | Specifies the response body format | application/json | No | [application/json] by default |
Response
Response Code
200
Response Header
| Header Name | Overview | Notes |
|---|---|---|
| Content-Type | Format of data to be returned | |
| Access-Control-Allow-Origin | Cross domain communication permission header | Return value fixed to "*" |
| X-Personium-Version | Personium API version | Version of the API used to process the request |
Response Body
Response is JSON format, defined in object (subobject).
The correspondence between key (name) and type, and value are as follows.
| Object | Name(Key) | Type | Value | Notes |
|---|---|---|---|---|
| Root | unit | object | Object (unit format) | |
| unit | url | string | The URL of the Unit | |
| unit | path_based_cellurl_enabled | boolean | true:path based cell url false:per cell fqdn url |
Error Messages
Refer to Error Message List
Response Sample
{
"unit": {
"url": "https://example.com/",
"path_based_cellurl_enabled": true
}
}
cURL Command
curl "https://unit1.example/" -X GET -i -H 'Accept: application/json'