---
title: "Web Host"
description: "Explore our comprehensive guide to web hosting platforms, storing tenants and plans efficiently for your data-driven needs. (Gitana 4.0)"
product: "Gitana"
version: "4.0"
url: "/documentation/gitana/4.0/reference/types/webhost"
---

# <a id="top"></a>Web Host

A Data Store

1.  [Platform](/documentation/gitana/4.0/reference/types/platform.md)
2.  [Web Host](/documentation/gitana/4.0/reference/types/webhost.md)

##### Table of Contents

- [Overview](#top "Overview")
- [Parent](#parent "Parent")
- [Objects](#objects "Objects")
- [Properties](#properties "Properties")
- [Methods](#methods "Methods")
- [Schema](#schema "Schema")

A web host is a data store where you store tenants and plans.

> **Note:** Drop in one of our language drivers to accelerate your development.  
> Here are links to some of our popular [Cookbooks](/documentation/gitana/4.0/developers/cookbooks/overview.md) to help you get started!
> 
> - [C#](/documentation/gitana/4.0/developers/cookbooks/csharp.md)
> - [Go](/documentation/gitana/4.0/developers/cookbooks/go.md)
> - [Java](/documentation/gitana/4.0/developers/cookbooks/java.md)
> - [JavaScript](/documentation/gitana/4.0/developers/cookbooks/javascript2.md)
> - [PHP](/documentation/gitana/4.0/developers/cookbooks/php.md)
> - [Python](/documentation/gitana/4.0/developers/cookbooks/python.md)
> - [Ruby](/documentation/gitana/4.0/developers/cookbooks/ruby.md)

## <a id="parent"></a>Parent

This Web Host is contained within a [Platform](/documentation/gitana/4.0/reference/types/platform.md).

## <a id="objects"></a>Objects

This Web Host contains the following objects:

- [Auto Client Mapping](/documentation/gitana/4.0/reference/types/autoClientMapping.md)
- [Trusted Domain Mapping](/documentation/gitana/4.0/reference/types/trustedDomainMapping.md)

## <a id="properties"></a>Properties

The following properties are available:

| Property | Type | Default | Read-Only | Description |
| --- | --- | --- | --- | --- |
| \_doc | string |  | No | The primary ID |
| \_system | object |  | No | Metadata maintained by the system |
| binaryStorageProviderType | string |  | No | The type identifier for the binary storage provider that backs this data store |
| datastoreId | string |  | Yes | The ID of the data store |
| datastoreTypeId | string |  | Yes | The data store type identifier |
| deployerTypes | array |  | No |  |
| description | string |  | No | A description of the data store |
| enableAuthorities | boolean | true | No | Whether to check access control rights for principals against this data store |
| key | string |  | No |  |
| locked | boolean |  | Yes | Whether the data store is presently locked. If the data store is locked, then write operations against it will block. |
| lockedBy | string |  | No | The principal that holds the lock (if the data store is locked) |
| maxsize | number |  | No | The maximum allowed allocation size (on disk) of the data store in bytes. If this size of the data store exceeds this value, write operations will fail. A value of -1 indicates that there is no upper limit. |
| objectcount | number |  | No | The number of objects stored within the data store. This includes system-maintained objects. This value is updated periodically and may not be precise at the moment it is read. |
| size | number |  | Yes | The last-recorded allocation size (on disk) of the data store in bytes. This value is updated periodically and may not be precise at the moment it is read. |
| statisticsDate | object |  | No | Records the time when statistics were last run against the data store. Statistics are run periodically to calculate the data store size and object allocations. |
| statisticsDirty | boolean |  | Yes | Whether writes have occurred against this data store since the last time statistics were run. This signals to the system that statistics need to be collected at the next available opportunity. |
| title | string |  | No | The title of the data store |

## <a id="methods"></a>Methods

The following methods are available:

- [Add Team Member](#post-webhosts-webhostid-teams-teamkey-members-add "Add Team Member")
- [Check Membership](#post-webhosts-webhostid-teams-teamkey-members-check "Check Membership")
- [Check Permission](#post-webhosts-webhostid-permissions-permissionid-check "Check Permission")
- [Check Single Authority](#post-webhosts-webhostid-authorities-authorityid-check "Check Single Authority")
- [Check multiple Authorities](#post-webhosts-authorities-check "Check multiple Authorities")
- [Check multiple Permissions](#post-webhosts-permissions-check "Check multiple Permissions")
- [Create Stat](#post-webhosts-webhostid-stats "Create Stat")
- [Create Web Host](#post-webhosts "Create Web Host")
- [Create a Team](#post-webhosts-webhostid-teams "Create a Team")
- [Delete Web Host](#delete-webhosts-webhostid "Delete Web Host")
- [Delete Web Host](#post-webhosts-webhostid-delete "Delete Web Host")
- [Deletes a Team](#delete-webhosts-webhostid-teams-teamkey "Deletes a Team")
- [Export Web Host](#post-webhosts-webhostid-export "Export Web Host")
- [Get Team](#get-webhosts-webhostid-teams-teamkey "Get Team")
- [Grant Authority](#post-webhosts-webhostid-authorities-authorityid-grant "Grant Authority")
- [Grant Authority to Team](#post-webhosts-webhostid-teams-teamkey-authorities-authorityid-grant "Grant Authority to Team")
- [Import Web Host](#post-webhosts-webhostid-import "Import Web Host")
- [List Team Authorities](#get-webhosts-webhostid-teams-teamkey-authorities "List Team Authorities")
- [List Teams](#get-webhosts-webhostid-teams "List Teams")
- [Lists Team Members](#get-webhosts-webhostid-teams-teamkey-members "Lists Team Members")
- [Lists Web Host](#get-webhosts "Lists Web Host")
- [Lock Webhost](#post-webhosts-webhostid-lock "Lock Webhost")
- [Queries for Web Host](#post-webhosts-query "Queries for Web Host")
- [Read ACL](#get-webhosts-webhostid-acl-list "Read ACL")
- [Read ACL for Principal](#get-webhosts-webhostid-acl "Read ACL for Principal")
- [Read Authorities Report](#post-webhosts-webhostid-authorities "Read Authorities Report")
- [Read Web Host](#get-webhosts-webhostid "Read Web Host")
- [Remove Team Member](#post-webhosts-webhostid-teams-teamkey-members-remove "Remove Team Member")
- [Revoke Authority](#post-webhosts-webhostid-authorities-authorityid-revoke "Revoke Authority")
- [Revoke Authority from Team](#post-webhosts-webhostid-teams-teamkey-authorities-authorityid-revoke "Revoke Authority from Team")
- [Unlock Webhost](#post-webhosts-webhostid-unlock "Unlock Webhost")
- [Update Web Host](#post-webhosts-webhostid-update "Update Web Host")
- [Update Web Host](#put-webhosts-webhostid "Update Web Host")
- [Update a Team](#put-webhosts-webhostid-teams-teamkey "Update a Team")

### <a id="post-webhosts-webhostid-teams-teamkey-members-add"></a>Add Team Member

Adds a principal as a member of a Team against the given webhost

POST /webhosts/{webhostId}/teams/{teamKey}/members/add

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}
```

### <a id="post-webhosts-webhostid-teams-teamkey-members-check"></a>Check Membership

Checks whether a principal belongs to a Team for the given webhost

POST /webhosts/{webhostId}/teams/{teamKey}/members/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Belongs",
  "extends": "status",
  "properties": {
    "belongs": {
      "type": "boolean"
    },
    "ok": null
  }
}
```

### <a id="post-webhosts-webhostid-permissions-permissionid-check"></a>Check Permission

Checks whether one or more authorities against the specified webhost are granted for a given set of users

POST /webhosts/{webhostId}/permissions/{permissionId}/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| permissionId | true | string | The ID of the permission |
| id | true | string |  |

#### Response

```json
{
  "$ref": "#/components/schemas/checkPermission"
}
```

### <a id="post-webhosts-webhostid-authorities-authorityid-check"></a>Check Single Authority

Checks whether a single authority is granted against the specified webhost for the given user

POST /webhosts/{webhostId}/authorities/{authorityId}/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}
```

### <a id="post-webhosts-authorities-check"></a>Check multiple Authorities

Checks whether one or more authorities against the specified webhost are granted for a given set of users

POST /webhosts/authorities/check

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

### <a id="post-webhosts-permissions-check"></a>Check multiple Permissions

Checks whether one or more permissions against the specified webhost are granted for a given set of users

POST /webhosts/permissions/check

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

### <a id="post-webhosts-webhostid-stats"></a>Create Stat

POST /webhosts/{webhostId}/stats

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

### <a id="post-webhosts"></a>Create Web Host

Creates a new Web Host

POST /webhosts

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-webhosts-webhostid-teams"></a>Create a Team

Creates a Team against the given webhost

POST /webhosts/{webhostId}/teams

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

#### Response

```json
{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}
```

### <a id="delete-webhosts-webhostid"></a>Delete Web Host

Deletes an existing Web Host

DELETE /webhosts/{webhostId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-webhosts-webhostid-delete"></a>Delete Web Host

Deletes an existing Web Host

POST /webhosts/{webhostId}/delete

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="delete-webhosts-webhostid-teams-teamkey"></a>Deletes a Team

Deletes a Team against the given webhost

DELETE /webhosts/{webhostId}/teams/{teamKey}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-webhosts-webhostid-export"></a>Export Web Host

Starts an export job for this resource

POST /webhosts/{webhostId}/export

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| groupId | false | string | The Group ID to be assigned to the exported archive |
| artifactId | false | string | The Artifact ID to be assigned to the exported archive |
| versionId | false | string | The Version ID to be assigned to the exported archive |
| vaultId | false | string | The ID of the vault where the exported archive should be saved |
| schedule | false | string | Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous') |

#### Response

```json
{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object",
      "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports."
    },
    "endDate": {
      "type": "object",
      "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports."
    },
    "startChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or beyond the specified changeset."
    },
    "endChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or before the specified changeset."
    },
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during export."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during export."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during export."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during export."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during export."
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}
```

### <a id="get-webhosts-webhostid-teams-teamkey"></a>Get Team

Retrieves a Team against the given webhost

GET /webhosts/{webhostId}/teams/{teamKey}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "extends": "document",
  "description": "Team",
  "properties": {
    "teamableObjectTypeId": {
      "type": "string",
      "readonly": true
    },
    "teamableObjectId": {
      "type": "string",
      "readonly": true
    },
    "key": {
      "type": "string"
    },
    "groupId": {
      "type": "string"
    },
    "groupDomainId": {
      "type": "string"
    },
    "roleKeys": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_doc": null,
    "_system": null
  }
}
```

### <a id="post-webhosts-webhostid-authorities-authorityid-grant"></a>Grant Authority

Grants an authority against the specified webhost to a given user

POST /webhosts/{webhostId}/authorities/{authorityId}/grant

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-webhosts-webhostid-teams-teamkey-authorities-authorityid-grant"></a>Grant Authority to Team

Assigns an Authority to a Team for the given webhost

POST /webhosts/{webhostId}/teams/{teamKey}/authorities/{authorityId}/grant

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |
| authorityId | true | string | The ID or authority key for the authority |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-webhosts-webhostid-import"></a>Import Web Host

Starts an import job for this resource

POST /webhosts/{webhostId}/import

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| groupId | false | string | The Group ID to be assigned to the exported archive |
| artifactId | false | string | The Artifact ID to be assigned to the exported archive |
| versionId | false | string | The Version ID to be assigned to the exported archive |
| vaultId | false | string | The ID of the vault where the exported archive should be saved |
| schedule | false | string | Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous') |

#### Response

```json
{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during import."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during import."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during import."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during import."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during import."
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": "CLONE",
      "description": "Either CLONE or COPY_EVERYTHING. Use CLONE to keep the same IDs on import. Use COPY_EVERYTHING to generate all new IDs for all entries on every import."
    },
    "substitutions": {
      "type": "string"
    }
  }
}
```

### <a id="get-webhosts-webhostid-teams-teamkey-authorities"></a>List Team Authorities

Retrieves a list of the authorities defined to be granted by a Team

GET /webhosts/{webhostId}/teams/{teamKey}/authorities

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "description": "List of Authorities",
  "properties": {
    "authorities": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  }
}
```

### <a id="get-webhosts-webhostid-teams"></a>List Teams

Lists the Teams against the given webhost

GET /webhosts/{webhostId}/teams

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}
```

### <a id="get-webhosts-webhostid-teams-teamkey-members"></a>Lists Team Members

Lists the members of a Team against the given webhost

GET /webhosts/{webhostId}/teams/{teamKey}/members

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object"
      }
    }
  }
}
```

### <a id="get-webhosts"></a>Lists Web Host

Retrieves a list of Web Host instances

GET /webhosts

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_webhost"
      }
    }
  }
}
```

### <a id="post-webhosts-webhostid-lock"></a>Lock Webhost

POST /webhosts/{webhostId}/lock

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

### <a id="post-webhosts-query"></a>Queries for Web Host

Queries for instances of type Web Host

POST /webhosts/query

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_webhost"
      }
    }
  }
}
```

### <a id="get-webhosts-webhostid-acl-list"></a>Read ACL

Read the Access Control List for the specified webhost

GET /webhosts/{webhostId}/acl/list

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

#### Response

```json
{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}
```

### <a id="get-webhosts-webhostid-acl"></a>Read ACL for Principal

Reads the ACL for a web host and specific actor

GET /webhosts/{webhostId}/acl

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}
```

### <a id="post-webhosts-webhostid-authorities"></a>Read Authorities Report

Read the Authorities Report for the specified webhost

POST /webhosts/{webhostId}/authorities

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

#### Response

```json
{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
```

### <a id="get-webhosts-webhostid"></a>Read Web Host

Reads an instance of a Web Host

GET /webhosts/{webhostId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

#### Response

```json
{
  "type": "object",
  "extends": "datastore",
  "container": "platform",
  "description": "Web Host",
  "properties": {
    "key": {
      "type": "string"
    },
    "deployerTypes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": null,
    "description": null,
    "datastoreId": null,
    "datastoreTypeId": null,
    "enableAuthorities": null,
    "size": null,
    "maxsize": null,
    "objectcount": null,
    "locked": null,
    "lockedBy": null,
    "statisticsDate": null,
    "statisticsDirty": null,
    "binaryStorageProviderType": null,
    "_doc": null,
    "_system": null
  }
}
```

### <a id="post-webhosts-webhostid-teams-teamkey-members-remove"></a>Remove Team Member

Remove a principal from a team's membership list

POST /webhosts/{webhostId}/teams/{teamKey}/members/remove

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-webhosts-webhostid-authorities-authorityid-revoke"></a>Revoke Authority

Revokes an authority against the specified webhost from a given user

POST /webhosts/{webhostId}/authorities/{authorityId}/revoke

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-webhosts-webhostid-teams-teamkey-authorities-authorityid-revoke"></a>Revoke Authority from Team

Revokes an Authority from a Team for the given webhost

POST /webhosts/{webhostId}/teams/{teamKey}/authorities/{authorityId}/revoke

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |
| authorityId | true | string | The ID or authority key for the authority |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-webhosts-webhostid-unlock"></a>Unlock Webhost

POST /webhosts/{webhostId}/unlock

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

### <a id="post-webhosts-webhostid-update"></a>Update Web Host

Updates an existing Web Host

POST /webhosts/{webhostId}/update

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="put-webhosts-webhostid"></a>Update Web Host

Updates an existing Web Host

PUT /webhosts/{webhostId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="put-webhosts-webhostid-teams-teamkey"></a>Update a Team

Updates a Team against the given webhost

PUT /webhosts/{webhostId}/teams/{teamKey}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| webhostId | true | string | The ID of the web host |
| teamKey | true | string | The key identifier for the team |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

## <a id="schema"></a>Schema

```json

{
  "type": "object",
  "extends": "datastore",
  "container": "platform",
  "description": "Web Host",
  "properties": {
    "key": {
      "type": "string"
    },
    "deployerTypes": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "title": null,
    "description": null,
    "datastoreId": null,
    "datastoreTypeId": null,
    "enableAuthorities": null,
    "size": null,
    "maxsize": null,
    "objectcount": null,
    "locked": null,
    "lockedBy": null,
    "statisticsDate": null,
    "statisticsDirty": null,
    "binaryStorageProviderType": null,
    "_doc": null,
    "_system": null
  },
  "id": "webhost"
}
```