Farm

Get

Retrieve the farm settings

GET/api/FarmSettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

namenullable string

The Name of the Farm.

Request

JavaScriptCurlPython

const response = await fetch('/api/FarmSettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

{
  "name": "text"
}

Update

Modify Farm Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

PUT/api/FarmSettings

Query parameters

Body

application/json; api-version=1.0

Farm Settings

newNamenullable string

The new name of the specified Farm name.

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/FarmSettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}