Create a File

POST/files/

API version

v2

Request method

POST

Operation ID

file-create-file

---

Request

Responses

Format

application/json

Description

Created

Schema documentation

• friendlyURLstring

  required

  deprecated, see friendlyUrl

• friendlyUrlstring

  required
• idstring (uuid)

  required
• mimeTypestring

  required
• namestring

  required
• sizeInBytesinteger

  required
• typestring

  required

  deprecated, see mimeType

Example

{
  "friendlyURL": "3fa85f64-5717-4562-b3fc-2c963f66afa6/me.jpeg",
  "friendlyUrl": "3fa85f64-5717-4562-b3fc-2c963f66afa6/me.jpeg",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mimeType": "image/jpeg",
  "name": "me.jpeg",
  "sizeInBytes": 300,
  "type": "image/jpeg"
}

JSON Schema

{
  "properties": {
    "friendlyURL": {
      "deprecated": true,
      "description": "deprecated, see friendlyUrl",
      "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6/me.jpeg",
      "type": "string"
    },
    "friendlyUrl": {
      "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6/me.jpeg",
      "type": "string"
    },
    "id": {
      "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "format": "uuid",
      "type": "string"
    },
    "mimeType": {
      "example": "image/jpeg",
      "type": "string"
    },
    "name": {
      "example": "me.jpeg",
      "type": "string"
    },
    "sizeInBytes": {
      "example": 300,
      "type": "integer"
    },
    "type": {
      "deprecated": true,
      "description": "deprecated, see mimeType",
      "example": "image/jpeg",
      "type": "string"
    }
  },
  "required": [
    "id",
    "name",
    "type",
    "friendlyURL",
    "friendlyUrl",
    "sizeInBytes",
    "mimeType"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/files

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.file.createFile({});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\File\CreateFile\CreateFileRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new CreateFileRequest());
$response = $client->file()->createFile($request);

var_dump($response->getBody();