Request a Server avatar upload

POST/servers/{serverId}/avatar/

API version

v2

Request method

POST

Operation ID

project-request-server-avatar-upload

---

Request

• serverIdstring (uuid)

  required

  ID of the Server to request an avatar upload for.

Responses

Format

application/json

Description

OK

Schema documentation

• refIdstring (uuid)

  required
• rulesobject

  required
  • maxSizeInKBinteger

    required
  • mimeTypesarray of string

    required
    • Array[
    • *string
    ]
• propertiesobject
  • imageDimensionsobject
    • maxobject
      • heightinteger
      • widthinteger
    • minobject
      • heightinteger
      • widthinteger

Example

{
  "refId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "rules": {
    "maxSizeInKB": 3000,
    "mimeTypes": [
      "image/jpeg",
      "image/png"
    ],
    "properties": {
      "imageDimensions": {
        "max": {
          "height": 123,
          "width": 123
        },
        "min": {
          "height": 123,
          "width": 123
        }
      }
    }
  }
}

JSON Schema

{
  "properties": {
    "refId": {
      "format": "uuid",
      "type": "string"
    },
    "rules": {
      "properties": {
        "maxSizeInKB": {
          "example": 3000,
          "type": "integer"
        },
        "mimeTypes": {
          "example": [
            "image/jpeg",
            "image/png"
          ],
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "properties": {
          "properties": {
            "imageDimensions": {
              "properties": {
                "max": {
                  "properties": {
                    "height": {
                      "type": "integer"
                    },
                    "width": {
                      "type": "integer"
                    }
                  },
                  "type": "object"
                },
                "min": {
                  "properties": {
                    "height": {
                      "type": "integer"
                    },
                    "width": {
                      "type": "integer"
                    }
                  },
                  "type": "object"
                }
              },
              "type": "object"
            }
          },
          "type": "object"
        }
      },
      "required": [
        "mimeTypes",
        "maxSizeInKB"
      ],
      "type": "object"
    }
  },
  "required": [
    "refId",
    "rules"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/servers/f0f86186-0a5a-45b2-aa33-502777496347/avatar

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.project.requestServerAvatarUpload({
  "serverId": "f0f86186-0a5a-45b2-aa33-502777496347"
});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\Project\RequestServerAvatarUpload\RequestServerAvatarUploadRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new RequestServerAvatarUploadRequest(
  serverId: "f0f86186-0a5a-45b2-aa33-502777496347"
));
$response = $client->project()->requestServerAvatarUpload($request);

var_dump($response->getBody();