Claris FileMaker Admin API

https://help.claris.com/en/admin-api-guide/content/
Admin
Claris FileMaker Admin API is a REST API that enables web services to perform administrative tasks...
Tokens:101,801
Snippets:258
Trust Score:10
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Response for Get Database Upload Info

Source: https://help.claris.com/en/admin-api-guide/content/get-upload-info

An example JSON response from the 'getdatabaseuploadinfo' API call, showing the URIs for database and remote container uploads.

```json
{
  "data" : {
    "db-upload-uri": "Secure/UploadTemp_FMS/09C750639B6969FE4FA7539EF80C873A/",
    "rc-upload-uri": "Secure/UploadTemp_FMS/09C750639B6969FE4FA7539EF80C873A/RC_Data_FMS/testdb/"
  },
  "result" : 0
}
```

--------------------------------

### API Request Example (JavaScript)

Source: https://help.claris.com/en/admin-api-guide/content/index

Shows how to send a POST request to the Claris API using JavaScript's Fetch API. This example illustrates creating a new user. It requires the Claris API endpoint and a valid API key for authentication.

```javascript
async function createUser(userData) {
  const response = await fetch('https://api.claris.com/v1/users', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(userData)
  });
  return await response.json();
}
```

--------------------------------

### API Request Example (cURL)

Source: https://help.claris.com/en/admin-api-guide/content/index

Demonstrates how to make a GET request to a Claris API endpoint using cURL. This is useful for testing API connectivity and retrieving data. Ensure you have a valid API key and endpoint URL.

```shell
curl -X GET "https://api.claris.com/v1/users" \ 
     -H "Authorization: Bearer YOUR_API_KEY" \ 
     -H "Content-Type: application/json"
```

--------------------------------

### Managing Layouts: Retrieving Layout Information

Source: https://help.claris.com/en/admin-api-guide/content/authentication-server

This code demonstrates how to fetch details about specific layouts within a Claris database. It includes an example of specifying the database name and layout name in the API request.

```javascript
// Example using JavaScript (fetch API) to get layout info
async function getLayoutInfo(databaseName, layoutName, token) {
  const response = await fetch(`https://your-claris-instance.claris.com/api/v1/databases/${databaseName}/layouts/${layoutName}`, {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${token}`
    }
  });
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  return await response.json();
}

// const dbName = 'MyDatabase';
// const layout = 'MyLayout';
// getLayoutInfo(dbName, layout, authToken).then(data => console.log(data)).catch(error => console.error('Error fetching layout info:', error));
```

--------------------------------

### Database Operations: Listing Databases

Source: https://help.claris.com/en/admin-api-guide/content/authentication-server

This snippet shows how to retrieve a list of all available databases within the Claris environment using the Admin API. It demonstrates the GET request to the databases endpoint and how to process the JSON response.

```shell
# Example using curl to list databases
curl -X GET \
  'https://your-claris-instance.claris.com/api/v1/databases' \
  -H 'Authorization: Bearer YOUR_AUTH_TOKEN'
```

--------------------------------

### Claris Studio Admin API Guide: Authentication

Source: https://help.claris.com/en/admin-api-guide/content/update-api-call

This snippet demonstrates how to authenticate with the Claris Studio Admin API using an API key. Proper authentication is required for all API requests. The examples cover C# and JavaScript.

```csharp
using System;
using System.Net.Http;
using System.Threading.Tasks;

public class ClarisAuthClient
{
    private readonly HttpClient _httpClient;

    public ClarisAuthClient()
    {
        _httpClient = new HttpClient();
        _httpClient.BaseAddress = new Uri("https://api.claris.studio/");
    }

    public async Task<string> AuthenticateAsync(string username, string password)
    {
        var credentials = new { username, password };
        var json = System.Text.Json.JsonSerializer.Serialize(credentials);
        var content = new StringContent(json, System.Text.Encoding.UTF8, "application/json");
        
        HttpResponseMessage response = await _httpClient.PostAsync("auth/login", content);
        response.EnsureSuccessStatusCode();
        
        var authResult = await System.Text.Json.JsonSerializer.DeserializeAsync<AuthResult>(await response.Content.ReadAsStreamAsync());
        return authResult.ApiKey;
    }

    private class AuthResult
    {
        public string ApiKey { get; set; }
    }
}

```

```javascript
async function authenticate(username, password) {
  const response = await fetch('https://api.claris.studio/auth/login', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ username, password })
  });
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  const authResult = await response.json();
  return authResult.apiKey;
}

```

--------------------------------

### User Management: Creating a New User

Source: https://help.claris.com/en/admin-api-guide/content/authentication-server

This section provides code examples for creating a new user within the Claris environment via the Admin API. It outlines the required user attributes and the API endpoint for user creation. Proper error handling should be implemented for production use.

```javascript
// Example using JavaScript (fetch API)
async function createUser(userData, token) {
  const response = await fetch('https://your-claris-instance.claris.com/api/v1/users', {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${token}`
    },
    body: JSON.stringify(userData)
  });
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  return await response.json();
}

const newUser = {
  "username": "newuser@example.com",
  "firstName": "New",
  "lastName": "User",
  "roles": ["viewer"]
};

// Assuming 'authToken' is obtained from the authentication step
// createUser(newUser, authToken).then(data => console.log(data)).catch(error => console.error('Error creating user:', error));
```

```python
# Example using Python (requests library)
import requests
import json

def create_user(user_data, token):
    url = 'https://your-claris-instance.claris.com/api/v1/users'
    headers = {
        'Content-Type': 'application/json',
        'Authorization': f'Bearer {token}'
    }
    response = requests.post(url, headers=headers, data=json.dumps(user_data))
    response.raise_for_status()  # Raise an exception for bad status codes
    return response.json()

new_user_data = {
    "username": "newuser@example.com",
    "firstName": "New",
    "lastName": "User",
    "roles": ["viewer"]
}

# Assuming 'auth_token' is obtained from the authentication step
# try:
#     created_user = create_user(new_user_data, auth_token)
#     print(created_user)
# except requests.exceptions.RequestException as e:
#     print(f"Error creating user: {e}")
```

--------------------------------

### Claris Studio Admin API Guide: Data Operations

Source: https://help.claris.com/en/admin-api-guide/content/update-api-call

This section details how to perform data operations using the Claris Studio Admin API. It covers creating, reading, updating, and deleting data entries. Examples are provided for C# and JavaScript.

```csharp
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

public class ClarisApiClient
{
    private readonly HttpClient _httpClient;
    private readonly string _apiKey;

    public ClarisApiClient(string apiKey)
    {
        _httpClient = new HttpClient();
        _httpClient.BaseAddress = new Uri("https://api.claris.studio/");
        _apiKey = apiKey;
        _httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {_apiKey}");
    }

    public async Task<string> GetDataAsync(string endpoint)
    {
        HttpResponseMessage response = await _httpClient.GetAsync(endpoint);
        response.EnsureSuccessStatusCode();
        return await response.Content.ReadAsStringAsync();
    }

    public async Task<string> PostDataAsync(string endpoint, object data)
    {
        var json = System.Text.Json.JsonSerializer.Serialize(data);
        var content = new StringContent(json, Encoding.UTF8, "application/json");
        HttpResponseMessage response = await _httpClient.PostAsync(endpoint, content);
        response.EnsureSuccessStatusCode();
        return await response.Content.ReadAsStringAsync();
    }

    public async Task<string> PutDataAsync(string endpoint, object data)
    {
        var json = System.Text.Json.JsonSerializer.Serialize(data);
        var content = new StringContent(json, Encoding.UTF8, "application/json");
        HttpResponseMessage response = await _httpClient.PutAsync(endpoint, content);
        response.EnsureSuccessStatusCode();
        return await response.Content.ReadAsStringAsync();
    }

    public async Task DeleteDataAsync(string endpoint)
    {
        HttpResponseMessage response = await _httpClient.DeleteAsync(endpoint);
        response.EnsureSuccessStatusCode();
    }
}

```

```javascript
async function fetchData(apiKey, endpoint) {
  const response = await fetch(`https://api.claris.studio/${endpoint}`, {
    method: 'GET',
    headers: {
      'Authorization': `Bearer ${apiKey}`
    }
  });
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  return await response.json();
}

async function postData(apiKey, endpoint, data) {
  const response = await fetch(`https://api.claris.studio/${endpoint}`, {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${apiKey}`
    },
    body: JSON.stringify(data)
  });
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  return await response.json();
}

async function putData(apiKey, endpoint, data) {
  const response = await fetch(`https://api.claris.studio/${endpoint}`, {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/json',
      'Authorization': `Bearer ${apiKey}`
    },
    body: JSON.stringify(data)
  });
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
  return await response.json();
}

async function deleteData(apiKey, endpoint) {
  const response = await fetch(`https://api.claris.studio/${endpoint}`, {
    method: 'DELETE',
    headers: {
      'Authorization': `Bearer ${apiKey}`
    }
  });
  if (!response.ok) {
    throw new Error(`HTTP error! status: ${response.status}`);
  }
}

```

--------------------------------

### API Response Example (JSON)

Source: https://help.claris.com/en/admin-api-guide/content/index

A sample JSON response from a Claris API endpoint, likely representing a list of users. This format is typical for data retrieval operations and includes user details like ID, name, and status.

```json
{
  "users": [
    {
      "id": "user-123",
      "name": "Alice Smith",
      "email": "alice.smith@example.com",
      "status": "active"
    },
    {
      "id": "user-456",
      "name": "Bob Johnson",
      "email": "bob.johnson@example.com",
      "status": "inactive"
    }
  ]
}
```

--------------------------------

### Fetching a List of Databases via Claris Admin API

Source: https://help.claris.com/en/admin-api-guide/content/index

This example shows how to retrieve a list of databases managed by the Claris Admin API. It requires a valid access token obtained through authentication. The response will typically be in JSON format.

```HTTP
GET /v1/databases HTTP/1.1
Host: api.claris.com
Authorization: Bearer <YOUR_ACCESS_TOKEN>
```

--------------------------------

### Claris Connect Admin API: Application Listing (Python)

Source: https://help.claris.com/en/admin-api-guide/content/uploading-apps-to-cloud

This Python snippet shows how to retrieve a list of all applications managed by Claris Connect using the Admin API. It involves making a GET request to the applications endpoint with appropriate authentication. The output is a JSON array of application objects.

```python
import requests

api_token = "YOUR_API_TOKEN"
headers = {
    "Authorization": f"Bearer {api_token}"
}

response = requests.get("/admin/api/v1/apps", headers=headers)

if response.status_code == 200:
    applications = response.json()
    print("Applications:", applications)
else:
    print(f"Error: {response.status_code}", response.text)
```

--------------------------------

### Append Database Part (HTTP Request Example)

Source: https://help.claris.com/en/admin-api-guide/content/append

This example demonstrates how to construct an HTTP PUT request to append a part of a database file using the Admin API. It includes the necessary headers for authentication and specifying the append status. The body of the request contains the file part to be uploaded.

```HTTP
PUT https://_instance-name_/fmws/{_db-upload-uri or rc-upload-uri_}/_DatabaseFilename_ HTTP/1.1
Host: _instance-name_
x-fms-command: append
x-fms-session-key: YOUR_SESSION_KEY
x-fms-append: 1
Content-Type: application/octet-stream

<binary file part data>
```

--------------------------------

### Error Handling Example (Python)

Source: https://help.claris.com/en/admin-api-guide/content/index

Illustrates how to handle potential API errors when interacting with the Claris Admin API using Python. This snippet shows checking the response status code and printing an error message if the request fails.

```python
import requests

api_url = "https://api.claris.com/v1/users"
headers = {"Authorization": "Bearer YOUR_API_KEY"}

try:
    response = requests.get(api_url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    data = response.json()
    print(data)
except requests.exceptions.RequestException as e:
    print(f"API request failed: {e}")
```

--------------------------------

### Initiate Database Upload Event - HTTP Request

Source: https://help.claris.com/en/admin-api-guide/content/upload-event

This example demonstrates how to initiate a database upload event using the Claris FileMaker Admin API. It requires setting specific HTTP headers, including the command, session key, and upload event type.

```http
GET https://_instance-name_/fmws/Secure/_DatabaseFilename_
Host: _instance-name_
Content-Type: application/json
x-fms-command: databaseuploadevent
x-fms-session-key: YOUR_SESSION_KEY
x-fms-upload-event: 1

```

--------------------------------

### CSS Navigation Styles

Source: https://help.claris.com/en/admin-api-guide/content/authentication-cloud

Provides CSS rules for styling a global navigation bar, including hover effects, responsive behavior for smaller screens, and menu toggling.

```css
.cs-globalnav.cs-globalnav-dropdown:hover{background-color:#fff;transition:background-color 0ms}.noscroll{position:fixed;width:100%;overflow-y:scroll}@media only screen and (max-width:1068px){.cs-globalnav{height:48px}.cs-globalnav .cs-navwrapper{width:100%;margin:0 auto}.cs-globalnav .cs-navwrapper .cs-menu-selector-nav{display:block!important;width:5%;height:48px;float:left}.cs-globalnav .cs-navwrapper .cs-nav-button-menu-label{position:absolute;width:48px;height:48px;display:block!important;float:left;cursor:pointer;right:0;margin:0 6px 0 0}.cs-globalnav .cs-navwrapper .cs-nav-button-menu-input{display:none}.cs-globalnav .cs-navwrapper .cs-nav-button-menu-input:checked~.cs-cover{z-index:-1;position:absolute;top:0;left:0;width:100%;height:100%;background-color:#fff}.cs-globalnav .cs-navwrapper .cs-nav-button-menu-input:checked~.cs-main-nav{position:fixed;background-color:#fff;overflow:scroll;display:block;max-height:99999px;transition:max-height .3s ease-in}.cs-globalnav .cs-navwrapper .cs-nav-button-menu-input:checked~.cs-main-nav a{font-size:24px;line-height:32px}.cs-globalnav .cs-navwrapper .cs-icon-menu-selector span{top:24px}.cs-globalnav .cs-navwrapper .cs-icon-menu-selector span::before{top:-4px}.cs-globalnav .cs-navwrapper .cs-icon-menu-selector span::after{bottom:-4px}.cs-globalnav .cs-logowrapper{width:70%;justify-content:left}.cs-globalnav .cs-main-nav{position:absolute;display:block;top:48px;width:100%;max-height:0;background-color:#333;overflow:hidden;transition:max-height .3s ease-out;height:auto;text-align:left}.cs-globalnav .cs-main-nav.cs-full-screen-menu{height:calc(100% - 48px)}.cs-globalnav .cs-ma
```

--------------------------------

### Add Users to Group - Request Example (Shell)

Source: https://help.claris.com/en/admin-api-guide/content/add-users-to-group

This snippet demonstrates the HTTP request to add users to a group using the Claris FileMaker Admin API. It includes the PUT method, the API endpoint URL, and the necessary Authorization and Content-Type headers.

```Shell
PUT /public/organizations/Team_ID/groups/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer Claris_ID_Token
```

--------------------------------

### FMPlugins API

Source: https://help.claris.com/en/admin-api-guide/content/admin-api-calls

Manage plugins for your FileMaker Cloud environment, including retrieving plugin lists, enabling/disabling individual plugins, and managing plugin installation scripts for various client types.

```APIDOC
## FMPlugins API

### Description
Manage plugins for your FileMaker Cloud environment, including retrieving plugin lists, enabling/disabling individual plugins, and managing plugin installation scripts for various client types.

### Endpoints

- **GET /fmi/admin/api/v1/fmplugins/list**
  Get the list of installed plug-ins.

- **PUT /fmi/admin/api/v1/fmplugins/{pluginId}/enable**
  Enable an individual plug-in.

- **PUT /fmi/admin/api/v1/fmplugins/{pluginId}/disable**
  Disable an individual plug-in.

- **PUT /fmi/admin/api/v1/fmplugins/scripts/wpe/install/enable**
  Enable the WPE install plug-in script.

- **PUT /fmi/admin/api/v1/fmplugins/scripts/wpe/install/disable**
  Disable the WPE install plug-in script.

- **PUT /fmi/admin/api/v1/fmplugins/wpe/enable**
  Enable WPE plug-ins.

- **PUT /fmi/admin/api/v1/fmplugins/wpe/disable**
  Disable WPE plug-ins.

- **PUT /fmi/admin/api/v1/fmplugins/scripts/dbs/install/enable**
  Enable the DBS install plug-in script.

- **PUT /fmi/admin/api/v1/fmplugins/scripts/dbs/install/disable**
  Disable the DBS install plug-in script.

- **PUT /fmi/admin/api/v1/fmplugins/dbs/enable**
  Enable DBS plug-ins.

- **PUT /fmi/admin/api/v1/fmplugins/dbs/disable**
  Disable DBS plug-ins.

- **PUT /fmi/admin/api/v1/fmplugins/scripts/dapi/install/enable**
  Enable the DAPI install plug-in script.

- **PUT /fmi/admin/api/v1/fmplugins/scripts/dapi/install/disable**
  Disable the DAPI install plug-in script.

- **PUT /fmi/admin/api/v1/fmplugins/dapi/enable**
  Enable DAPI plug-ins.

- **PUT /fmi/admin/api/v1/fmplugins/dapi/disable**
  Disable DAPI plug-ins.

- **GET /fmi/admin/api/v1/fmplugins/dbs/configuration**
  Get DBS plug-in configuration.

- **GET /fmi/admin/api/v1/fmplugins/wpe/configuration**
  Get WPE plug-in configuration.

- **GET /fmi/admin/api/v1/fmplugins/dapi/configuration**
  Get DAPI plug-in configuration.

### Parameters

#### Path Parameters
- **pluginId** (string) - Required - The unique identifier of the plug-in.

### Request Example (Enable Individual Plugin)
(Assuming a pluginId of 'com.example.plugin')
`PUT /fmi/admin/api/v1/fmplugins/com.example.plugin/enable`

### Response Example (Get Plugin List)
```json
[
  {
    "id": "com.example.plugin",
    "name": "Example Plugin",
    "version": "1.0.0",
    "enabled": true
  }
]
```
```

--------------------------------

### Updating Database Settings via Claris Admin API

Source: https://help.claris.com/en/admin-api-guide/content/index

This example demonstrates how to update the settings of an existing database using the Claris Admin API. It uses a PUT request with the database ID and the updated settings in the JSON payload. This operation requires appropriate permissions.

```HTTP
PUT /v1/databases/{databaseId} HTTP/1.1
Host: api.claris.com
Content-Type: application/json
Authorization: Bearer <YOUR_ACCESS_TOKEN>

{
  "description": "Updated description for the database.",
  "is_enabled": true
}
```

--------------------------------

### Claris Connect Admin API: Fetching Webhook Details (Python)

Source: https://help.claris.com/en/admin-api-guide/content/uploading-apps-to-cloud

This Python snippet illustrates how to fetch detailed information about a specific Claris Connect webhook using its ID. It makes a GET request to the webhook's specific endpoint. The response contains the webhook's configuration and status.

```python
import requests

api_token = "YOUR_API_TOKEN"
webhook_id = "specific_webhook_id"
headers = {
    "Authorization": f"Bearer {api_token}"
}

response = requests.get(f"/admin/api/v1/webhooks/{webhook_id}", headers=headers)

if response.status_code == 200:
    webhook_details = response.json()
    print("Webhook details:", webhook_details)
else:
    print(f"Error: {response.status_code}", response.text)
```

--------------------------------

### Claris Studio Admin API Endpoint Example (C#)

Source: https://help.claris.com/en/admin-api-guide/content/admin-api-reference

This C# code snippet demonstrates how to construct a request to a Claris Studio Admin API endpoint. It highlights setting up the HTTP client, defining the request URL, and preparing the request body. Ensure correct API keys and endpoint URLs are used for successful execution. Error handling for network issues or API responses is recommended.

```csharp
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

public class ClarisStudioApiClient
{
    private readonly HttpClient _httpClient;
    private readonly string _apiKey;

    public ClarisStudioApiClient(string apiKey)
    {
        _httpClient = new HttpClient();
        _apiKey = apiKey;
        _httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {_apiKey}");
    }

    public async Task<string> GetResourceAsync(string endpointUrl)
    {
        try
        {
            HttpResponseMessage response = await _httpClient.GetAsync(endpointUrl);
            response.EnsureSuccessStatusCode(); // Throw if status code is not 2xx
            return await response.Content.ReadAsStringAsync();
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Request error: {e.Message}");
            return null;
        }
    }

    public async Task<string> PostResourceAsync(string endpointUrl, string jsonPayload)
    {
        try
        {
            var content = new StringContent(jsonPayload, Encoding.UTF8, "application/json");
            HttpResponseMessage response = await _httpClient.PostAsync(endpointUrl, content);
            response.EnsureSuccessStatusCode(); // Throw if status code is not 2xx
            return await response.Content.ReadAsStringAsync();
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Request error: {e.Message}");
            return null;
        }
    }

    // Example usage:
    public static async Task Main(string[] args)
    {
        string apiKey = "YOUR_API_KEY"; // Replace with your actual API key
        string baseUrl = "https://api.claris.studio/"; // Replace with your Claris Studio API base URL

        var client = new ClarisStudioApiClient(apiKey);

        // Example: Get a list of projects
        string projectsEndpoint = baseUrl + "projects";
        string projectsJson = await client.GetResourceAsync(projectsEndpoint);
        Console.WriteLine("Projects:");
        Console.WriteLine(projectsJson);

        // Example: Create a new project (replace payload with actual data)
        string createProjectEndpoint = baseUrl + "projects";
        string newProjectPayload = "{\"name\": \"My New Project\", \"description\": \"A sample project\"}";
        string createdProjectJson = await client.PostResourceAsync(createProjectEndpoint, newProjectPayload);
        Console.WriteLine("Created Project:");
        Console.WriteLine(createdProjectJson);
    }
}
```

--------------------------------

### Get Database Upload Info

Source: https://help.claris.com/en/admin-api-guide/content/get-upload-info

Retrieves URIs for temporary folders on the host used for uploading database and remote container files.

```APIDOC
## GET /fmws/Secure/_DatabaseFilename_

### Description
Use this API call to return the URIs for the temporary folders on the host, which are used for uploading the database file and the remote container files.

### Method
GET

### Endpoint
`https://<_instance-name_>/fmws/Secure/_DatabaseFilename_`

### Headers
- **x-fms-command** (string) - Required - The command for the API call. For this header, "getdatabaseuploadinfo" is the only value allowed.
- **x-fms-session-key** (string) - Required - The session key returned from the Authentication API call.

### Request Body
Empty

### Response
#### Success Response (200)
- **data** (object) - Contains upload URIs.
  - **db-upload-uri** (string) - URI for the database folder.
  - **rc-upload-uri** (string) - URI for the remote containers folder.
- **result** (integer) - The API call result code.

#### Response Example
```json
{
  "data" : {
    "db-upload-uri": "Secure/UploadTemp_FMS/09C750639B6969FE4FA7539EF80C873A/",
    "rc-upload-uri": "Secure/UploadTemp_FMS/09C750639B6969FE4FA7539EF80C873A/RC_Data_FMS/testdb/"
  },
  "result" : 0
}
```
```

--------------------------------

### Example API Response (Error Header)

Source: https://help.claris.com/en/admin-api-guide/content/append

This snippet illustrates how an error might be indicated in the response headers. The 'x-FMS-Result' and 'x-FMS-Error' headers provide information about the outcome of the API call, such as access denial.

```HTTP
x-FMS-Result: 9
x-FMS-Error: (9): Access was denied
```

--------------------------------

### Creating a New Database via Claris Admin API

Source: https://help.claris.com/en/admin-api-guide/content/index

This snippet illustrates the process of creating a new database using the Claris Admin API. It involves sending a POST request with the database details in the request body, usually in JSON format. Ensure the provided details are valid.

```HTTP
POST /v1/databases HTTP/1.1
Host: api.claris.com
Content-Type: application/json
Authorization: Bearer <YOUR_ACCESS_TOKEN>

{
  "name": "NewDatabase",
  "description": "A newly created database."
}
```

--------------------------------

### Authentication and Authorization with Claris Admin API

Source: https://help.claris.com/en/admin-api-guide/content/authentication-server

This snippet demonstrates how to authenticate with the Claris Admin API using API keys and obtain authorization tokens. It covers the request format and expected response for a successful authentication.

```shell
# Example using curl for authentication
curl -X POST \
  'https://your-claris-instance.claris.com/api/v1/auth/token' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{ "grant_type": "client_credentials" }'
```

--------------------------------

### Example API Response (Success)

Source: https://help.claris.com/en/admin-api-guide/content/append

This snippet shows a successful response from the append API call. A 'result' code of 0 typically indicates success. Response headers should also be checked for any specific status or error codes.

```JSON
{
  "result": 0
}
```

--------------------------------

### Accessing Claris Studio Admin API with C#

Source: https://help.claris.com/en/admin-api-guide/content/index

This C# code snippet demonstrates how to authenticate and make requests to the Claris Studio Admin API. It utilizes standard .NET libraries for HTTP communication and JSON serialization. Ensure you have the necessary API keys and endpoint URLs for successful execution. Error handling for network issues and API response codes is recommended.

```csharp
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

public class ClarisStudioApiClient
{
    private readonly HttpClient _httpClient;
    private readonly string _apiKey;
    private readonly string _apiEndpoint;

    public ClarisStudioApiClient(string apiKey, string apiEndpoint)
    {
        _httpClient = new HttpClient();
        _apiKey = apiKey;
        _apiEndpoint = apiEndpoint;
        _httpClient.DefaultRequestHeaders.Add("Authorization", $"Bearer {_apiKey}");
    }

    public async Task<string> GetDataAsync(string resourcePath)
    {
        try
        {
            HttpResponseMessage response = await _httpClient.GetAsync($"{_apiEndpoint}/{resourcePath}");
            response.EnsureSuccessStatusCode(); // Throws an exception if the status code is unsuccessful
            return await response.Content.ReadAsStringAsync();
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Request error: {e.Message}");
            return null;
        }
    }

    public async Task<string> PostDataAsync(string resourcePath, string jsonData)
    {
        try
        {
            var content = new StringContent(jsonData, Encoding.UTF8, "application/json");
            HttpResponseMessage response = await _httpClient.PostAsync($"{_apiEndpoint}/{resourcePath}", content);
            response.EnsureSuccessStatusCode();
            return await response.Content.ReadAsStringAsync();
        }
        catch (HttpRequestException e)
        {
            Console.WriteLine($"Request error: {e.Message}");
            return null;
        }
    }

    // Add other methods for PUT, DELETE, etc. as needed
}

// Example Usage:
// var client = new ClarisStudioApiClient("YOUR_API_KEY", "YOUR_API_ENDPOINT");
// var data = await client.GetDataAsync("some/resource");
// Console.WriteLine(data);

```

--------------------------------

### File Upload Check Response Header - FileMaker Admin API

Source: https://help.claris.com/en/admin-api-guide/content/check-file-upload

Response headers for the file upload check API call can indicate specific error conditions. For example, an 'x-FMS-Result' of 9 signifies an access denied error.

```HTTP
"x-FMS-Result" : 9
"x-FMS-Error" : (9): Access was denied
```

--------------------------------

### Cancel Database Upload Event - HTTP Request

Source: https://help.claris.com/en/admin-api-guide/content/upload-event

This example illustrates how to cancel a database upload event using the Claris FileMaker Admin API. It requires specifying the command, session key, and the cancel event type in the HTTP headers.

```http
GET https://_instance-name_/fmws/Secure/_DatabaseFilename_
Host: _instance-name_
Content-Type: application/json
x-fms-command: databaseuploadevent
x-fms-session-key: YOUR_SESSION_KEY
x-fms-upload-event: 3

```

--------------------------------

### Authentication with Claris Admin API

Source: https://help.claris.com/en/admin-api-guide/content/index

This snippet demonstrates how to authenticate with the Claris Admin API. It typically involves obtaining an access token using provided credentials. Ensure you handle your API keys and tokens securely.

```HTTP
POST /oauth/token HTTP/1.1
Host: api.claris.com
Content-Type: application/x-www-form-urlencoded

grant_type=password&username=<YOUR_USERNAME>&password=<YOUR_PASSWORD>&client_id=<YOUR_CLIENT_ID>&client_secret=<YOUR_CLIENT_SECRET>
```

--------------------------------

### Responsive Column Layout CSS

Source: https://help.claris.com/en/admin-api-guide/content/uploading-apps-to-cloud

Defines CSS rules for flexible column layouts that adapt to different screen sizes. It includes styles for three-column and two-column arrangements, adjusting column widths and flex direction based on viewport dimensions.

```css
.lg-m-three-column-wrap .column-3,.xl-lg-m-three-column-wrap .column-4,.xl-lg-m-three-column-wrap .column-5,.xl-lg-m-three-column-wrap .column-6{width:33.33333%}}@media only screen and (min-width:736px) and (max-width:1068px){.m-direction-column{flex-direction:column;align-content:flex-start}.m-three-column-wrap,.m-two-column-wrap{flex-wrap:wrap}.m-two-column-wrap .column-2,.m-two-column-wrap .column-3,.m-two-column-wrap .column-4,.m-two-column-wrap .column-5,.m-two-column-wrap .column-6{width:50%}.m-three-column-wrap .column-3,.m-three-column-wrap .column-4,.m-three-column-wrap .column-5,.m-three-column-wrap .column-6{width:33.33333%}}@media only screen and (max-width:735px){.m-sm-direction-column,.sm-direction-column{flex-direction:column;align-content:flex-start}.m-sm-three-column-wrap,.m-sm-two-column-wrap,.sm-three-column-wrap,.sm-two-column-wrap{flex-wrap:wrap}.m-sm-two-column-wrap .column-2,.m-sm-two-column-wrap .column-3,.m-sm-two-column-wrap .column-4,.m-sm-two-column-wrap .column-5,.m-sm-two-column-wrap .column-6,.sm-two-column-wrap .column-2,.sm-two-column-wrap .column-3,.sm-two-column-wrap .column-4,.sm-two-column-wrap .column-5,.sm-two-column-wrap .column-6{width:50%}.m-sm-three-column-wrap .column-3,.m-sm-three-column-wrap .column-4,.m-sm-three-column-wrap .column-5,.m-sm-three-column-wrap .column-6,.sm-three-column-wrap .column-3,.sm-three-column-wrap .column-4,.sm-three-column-wrap .column-5,.sm-three-column-wrap .column-6{width:33.33333%}.callout-blue{padding:50px;background-color:#e5f5fd}}
```

--------------------------------

### Add Users to Group - Response Body Example (JSON)

Source: https://help.claris.com/en/admin-api-guide/content/add-users-to-group

This JSON object illustrates the response received after attempting to add users to a group using the Claris FileMaker Admin API. It details the success or failure status for each user, along with a request ID.

```JSON
{
  "code": "OK",
  "message": null,
  "succeeded": [
    {
      "request": {
        "email": "user1@example.com",
        "isIdpUser": false
      },
      "code": "OK",
      "message": null
    }
  ],
  "failed": [
    {
      "request": {
        "email": "user2@example.com",
        "isIdpUser": false
      },
      "code": "EmailNotValid",
      "message": "user2@example.com is not a valid email."
    }
  ],
  "requestId": "{Request_ID}"
}
```

--------------------------------

### Report Database Upload Error Event - HTTP Request

Source: https://help.claris.com/en/admin-api-guide/content/upload-event

This example demonstrates how to report an error during a database upload event using the Claris FileMaker Admin API. It includes the necessary command, session key, and error event type in the HTTP request.

```http
GET https://_instance-name_/fmws/Secure/_DatabaseFilename_
Host: _instance-name_
Content-Type: application/json
x-fms-command: databaseuploadevent
x-fms-session-key: YOUR_SESSION_KEY
x-fms-upload-event: 4

```

--------------------------------

### Let's Encrypt API

Source: https://help.claris.com/en/admin-api-guide/content/admin-api-calls

Automate the process of obtaining and renewing SSL certificates using Let's Encrypt for your FileMaker Cloud environment.

```APIDOC
## Let's Encrypt API

### Description
Automate the process of obtaining and renewing SSL certificates using Let's Encrypt for your FileMaker Cloud environment.

### Endpoints

- **POST /fmi/admin/api/v1/letsencrypt/request**
  Request a new Let's Encrypt certificate.

- **POST /fmi/admin/api/v1/letsencrypt/renew**
  Renew an existing Let's Encrypt certificate.

### Parameters

#### Request Body (POST /fmi/admin/api/v1/letsencrypt/request)
- **domain** (string) - Required - The domain name for which to obtain the certificate.
- **email** (string) - Required - The email address to associate with the Let's Encrypt account.

#### Request Body (POST /fmi/admin/api/v1/letsencrypt/renew)
- **domain** (string) - Required - The domain name of the certificate to renew.

### Request Example (Request Certificate)
```json
{
  "domain": "yourdomain.com",
  "email": "admin@yourdomain.com"
}
```

### Response Example (Renew Certificate)
```json
{
  "message": "Let's Encrypt certificate renewed successfully."
}
```
```

--------------------------------

### Database Sign-in Settings API

Source: https://help.claris.com/en/admin-api-guide/content/admin-api-calls

Configure database sign-in settings for various external server account types, including generic external servers, Amazon, Google, Microsoft, AppleID, and custom OAuth.

```APIDOC
## Database Sign-in Settings API

### Description
Configure database sign-in settings for various external server account types, including generic external servers, Amazon, Google, Microsoft, AppleID, and custom OAuth.

### Endpoints

- **GET /fmi/admin/api/v1/databasesignin/externalserver**
  Get database sign-in settings for external server accounts.

- **PUT /fmi/admin/api/v1/databasesignin/externalserver**
  Update database sign-in settings for external server accounts.

- **GET /fmi/admin/api/v1/databasesignin/amazon**
  Get database sign-in settings for Amazon.

- **PUT /fmi/admin/api/v1/databasesignin/amazon**
  Update database sign-in settings for Amazon.

- **GET /fmi/admin/api/v1/databasesignin/google**
  Get database sign-in settings for Google.

- **PUT /fmi/admin/api/v1/databasesignin/google**
  Update database sign-in settings for Google.

- **GET /fmi/admin/api/v1/databasesignin/microsoft**
  Get database sign-in settings for Microsoft.

- **PUT /fmi/admin/api/v1/databasesignin/microsoft**
  Update database sign-in settings for Microsoft.

- **GET /fmi/admin/api/v1/databasesignin/appleid**
  Get database sign-in settings for AppleID.

- **PUT /fmi/admin/api/v1/databasesignin/appleid**
  Update database sign-in settings for AppleID.

- **GET /fmi/admin/api/v1/databasesignin/customoauth**
  Get database sign-in settings for custom OAuth.

- **PUT /fmi/admin/api/v1/databasesignin/customoauth**
  Update database sign-in settings for custom OAuth.

### Parameters

(Note: Specific parameters for PUT requests would be detailed here based on actual API design, e.g., credentials or configuration details.)

### Request Example (Update Google Sign-in Settings)
```json
{
  "clientId": "google-client-id",
  "clientSecret": "google-client-secret"
}
```

### Response Example (Get External Server Settings)
```json
{
  "enabled": true,
  "serverAddress": "your-external-server.com"
}
```
```

--------------------------------

### CSS Global Navigation Background Themes

Source: https://help.claris.com/en/admin-api-guide/content/uploading-apps-to-cloud

Defines styles for different background themes of the global navigation, including solid, transparent, and scrolled variations with different color schemes.

```css
.cs-global-nav-bkg-sld-blk .cs-globalnav .cs-navwrapper .cs-icon-menu-selector span::before,
.cs-global-nav-bkg-sld-blk .cs-globalnav .cs-navwrapper .cs-icon-menu-selector span:after,
.cs-global-nav-bkg-sld-blk-scl-wht .cs-globalnav .cs-navwrapper .cs-icon-menu-selector span::before,
.cs-global-nav-bkg-sld-blk-scl-wht .cs-globalnav .cs-navwrapper .cs-icon-menu-selector span:after,
.cs-global-nav-bkg-sld-wht .cs-globalnav,
.cs-globalnav.cs-global-nav-bkg-sld-blk .cs-navwrapper .cs-icon-menu-selector span::before,
.cs-globalnav.cs-global-nav-bkg-sld-blk .cs-navwrapper .cs-icon-menu-selector span:after,
.cs-globalnav.cs-global-nav-bkg-sld-blk-scl-wht .cs-navwrapper .cs-icon-menu-selector span::before,
.cs-globalnav.cs-global-nav-bkg-sld-blk-scl-wht .cs-navwrapper .cs-icon-menu-selector span:after,
.cs-globalnav.cs-global-nav-bkg-sld-wht,
.global-nav-bkg-sld-wht .cs-globalnav {
  background-color: #fff;
}
.cs-global-nav-bkg-sld-blk .cs-globalnav,
.cs-globalnav.cs-global-nav-bkg-sld-blk {
  background-color: #22221f;
}
.cs-global-nav-bkg-sld-blk .cs-globalnav a,
.cs-globalnav.cs-global-nav-bkg-sld-blk a {
  color: #fff;
}
.cs-global-nav-bkg-sld-blk .cs-globalnav.cs-transparent .cs-gnav-section.selected .cs-gnav-name,
.cs-globalnav.cs-global-nav-bkg-sld-blk.cs-transparent .cs-gnav-section.selected .cs-gnav-name {
  color: #111;
}
.cs-global-nav-bkg-sld-blk .cs-globalnav .cs-navwrapper .cs-main-nav .cs-items li.cs-gnav-section.cs-gnav-alt:hover a,
.cs-global-nav-bkg-sld-blk .cs-globalnav .cs-navwrapper a:hover,
.cs-globalnav.cs-global-nav-bkg-sld-blk .cs-navwrapper .cs-main-nav .cs-items li.cs-gnav-section.cs-gnav-alt:hover a,
.cs-globalnav.cs-global-nav-bkg-sld-blk .cs-navwrapper a:hover {
  color: #4fe669;
}
.cs-global-nav-bkg-sld-blk .cs-globalnav .cs-navwrapper .cs-gnav-section.selected .cs-gnav-name,
.cs-globalnav.cs-global-nav-bkg-sld-blk .cs-navwrapper .cs-gnav-section.selected .cs-gnav-name {
  color: #fff;
  font-weight: 400;
}
.cs-global-nav-bkg-sld-blk .cs-globalnav .cs-navwrapper .cs-main-nav .cs-items li.cs-gnav-section.cs-gnav-alt a,
.cs-global-nav-bkg-sld-blk .cs-globalnav .cs-navwrapper .cs-main-nav 
```

--------------------------------

### Get Database Upload Info API Call

Source: https://help.claris.com/en/admin-api-guide/content/get-upload-info

Retrieves URIs for temporary host folders used for uploading database and remote container files. Requires an 'x-fms-command' header with 'getdatabaseuploadinfo' and an 'x-fms-session-key' from authentication. Returns URIs for database and remote container uploads, along with a result code.

```HTTP
GET https://_instance-name_/fmws/Secure/_DatabaseFilename_

HTTP Headers:
  x-fms-command: getdatabaseuploadinfo
  x-fms-session-key: <your_session_key>
```

--------------------------------

### HTML Newsletter Signup Form Structure

Source: https://help.claris.com/en/admin-api-guide/content/authentication-cloud

Provides the HTML structure for the newsletter signup section. It includes a heading, descriptive text, a form with various hidden input fields for tracking campaign and user data, and a placeholder for the submit button.

```html
<script defer type="text/javascript" src="/site/includes/email-signup/js/pre-newsletter.js?v=8"></script>

<div id="newsletter-wrapper" class="dark">
	<div id="newsletter-signup">
		<!-- <p class="h2">Claris Newsletter</p> -->
		<p class="p-signup">Sign up for the Claris Newsletter.</p>
		<form id="newsletter-form" class="form-wrapper" method="" action="" novalidate="novalidate">
			<input id="newsletter-language" class="input-field" name="Language" type="hidden" value="EN">
			<input class="input-field" name="Campaign" type="hidden" value="0121-515-AMR-EN-CLARIS-ENEWS-EM">
			<input class="input-field" name="Profile" type="hidden" value="Default">
			<input name="platform" type="hidden" value="">
			<input type="hidden" name="utm_campaign" value="">
			<input type="hidden" name="utm_source" value="">

```

--------------------------------

### End Database Upload Event - HTTP Request

Source: https://help.claris.com/en/admin-api-guide/content/upload-event

This example shows how to signal the successful completion of a database upload event using the Claris FileMaker Admin API. It involves sending a specific HTTP request with the appropriate session key and upload event type.

```http
GET https://_instance-name_/fmws/Secure/_DatabaseFilename_
Host: _instance-name_
Content-Type: application/json
x-fms-command: databaseuploadevent
x-fms-session-key: YOUR_SESSION_KEY
x-fms-upload-event: 2

```
Tokens:
Raw