How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Box Metadata Instances (Files) API

A metadata instance describesthe relation between a template and a file,including the values that are assigned for every field.

Box Metadata Instances (Files) API is one of 81 APIs that Box publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Metadata Instances (Files). The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://api.box.com/2.0.

5 operations 2 paths 5 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://account.box.com/api/oauth2
Authentication
OAuth 2.0
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Box Metadata Instances (Files) API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 9 scopes. By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Metadata Instances (Files) 5

A metadata instance describes the relation between a template and a file, including the values that are assigned for every field.

GET
/files/{file_id}/metadata
Box List metadata instances on file
get_files_id_metadata 1 param → 200403404default
GET
/files/{file_id}/metadata/{scope}/{template_key}
Box Get metadata instance on file
get_files_id_metadata_id_id 3 params → 201403404405default
POST
/files/{file_id}/metadata/{scope}/{template_key}
Box Create metadata instance on file
post_files_id_metadata_id_id 3 params body → 201400404409default
PUT
/files/{file_id}/metadata/{scope}/{template_key}
Box Update metadata instance on file
put_files_id_metadata_id_id 3 params body → 200400500default
DELETE
/files/{file_id}/metadata/{scope}/{template_key}
Box Remove metadata instance from file
delete_files_id_metadata_id_id 3 params → 204400404405default

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are ClientError (7 properties), Metadata--Base (4 properties), Metadatas (2 properties). Each schema is shown below with its type and property counts.

Metadata--Full
object
An instance of a metadata template, which has been applied to a file or folder.
ClientError
object
A generic error
7 properties
Metadata--Base
object
The base representation of a metadata instance.
4 properties
Metadata
object
An instance of a metadata template, which has been applied to a file or folder.
Metadatas
object
A list of metadata instances that have been applied to a file or folder.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

box-metadata-instances-files-api-openapi.yml Raw ↑

Other APIs Box publishes across the network.

Box Authorization API
Box Authorize API
Box Classifications API
Box Classifications on Files API
Box Classifications on Folders API
Box Collaboration Whitelist Entries API
Box Collaboration Whitelist Exempt Targets API
Box Collaborations API
Box Collaborations (List) API
Box Collections API
Box Comments API
Box Device Pinners API
Where this information came from

This is an independent, third-party profile of Box Metadata Instances (Files) API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.