Create Entity Directory File

PUT 
/file/v1/:file_type/:entity_type/:entity_id/:file_name

Upload a file to entity storage for the provided entity_id. This endpoint will accept a multipart/form-data by default when the request's content-type is not provided. When a content-type is provided, the request body will be as raw bytes.

Request

Path Parameters

file_type FileTyperequired

Possible values: [file, developer-file]

file_name File Namerequired
entity_type EntityTyperequired

Possible values: [match, unknown]

entity_id Entity Idrequired

Header Parameters

content-type Content-Type

multipart/form-data

Body

required

file binary

application/octet-stream

Body

required

string

Responses

204

Successful Response

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...