> For the complete documentation index, see [llms.txt](https://docs.opshub.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opshub.com/v7.237/mbse-connector-sdk-index/mbse-sdk-connector-apis/metadata-apis/server-info.md).

# Get Server Info

## API Name

API Name: Server Info – Get

***

## Overview

This API returns server-level configuration information required by MBSE Core to interact correctly with the end system.

MBSE Core uses this API to:

* Understand system time zone behavior
* Determine maximum supported page size
* Identify integration user configuration

Connector responsibility:

* Provide accurate server configuration details.
* Return pagination limits supported by the system.
* Return integration user configuration metadata.

***

### API URI

```bash
GET: /mbse/api/1.0/server-info
```

***

## Response Parameters

### Root Level Parameters

| Name                | Required | Type    | Description                                                                                                                                                                                                                                    |
| ------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| timeZone            | No       | String  | Time zone of the end system. Examples: `"America/Los_Angeles"`, `"GMT-8:00"`, `"UTC"`. Return blank if timezone is embedded in date values returned by the system.                                                                             |
| maxResults          | Yes      | Integer | Maximum number of records that can be returned in a single paginated API response. If the end system does not support pagination natively, the connector must implement in-memory pagination and provide the maximum supported page size here. |
| integrationUserInfo | Yes      | Object  | Information about the integration user configuration.                                                                                                                                                                                          |

***

### integrationUserInfo Object

| Name              | Required | Type   | Description                                                                                                                                                                                     |
| ----------------- | -------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| fieldInternalName | Yes      | String | Internal name of the field used in the system configuration screen to capture the integration username or email. This must match the corresponding field defined in the Connector Metadata API. |
| userDataType      | Yes      | Enum   | <p>Data type of the integration user field. Valid values:<br>- <code>EMAIL\_AS\_USER</code><br>- <code>USERNAME\_AS\_USER</code></p>                                                            |

***

## Response Payload

```json
{
  "timeZone": "UTC",
  "maxResults": 50,
  "integrationUserInfo": {
    "userDataType": "USERNAME_AS_USER",
    "fieldInternalName": "userName"
  }
}
```

***

## Behavior Rules

1. `maxResults` must always be provided.
2. If the end system does not support pagination:
   * The connector must implement pagination internally.
   * `maxResults` must reflect the enforced page size.
3. `timeZone` must be provided if timestamps do not contain timezone information.
4. `fieldInternalName` must match a field defined in the Connector Metadata API.

***

## Design Rationale

This API ensures MBSE Core can:

* Interpret timestamps correctly.
* Enforce safe pagination limits.
* Identify integration user context consistently.

Accurate server configuration is critical for reliable synchronization and data integrity.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.opshub.com/v7.237/mbse-connector-sdk-index/mbse-sdk-connector-apis/metadata-apis/server-info.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.